diff --git a/configure.ac b/configure.ac index 0c588ef589..1bff606af9 100644 --- a/configure.ac +++ b/configure.ac @@ -1,1480 +1,1475 @@ dnl dnl autoconf for Pacemaker dnl dnl License: GNU General Public License (GPL) dnl =============================================== dnl Bootstrap dnl =============================================== AC_PREREQ(2.53) dnl Suggested structure: dnl information on the package dnl checks for programs dnl checks for libraries dnl checks for header files dnl checks for types dnl checks for structures dnl checks for compiler characteristics dnl checks for library functions dnl checks for system services AC_INIT(pacemaker, 1.0.6, pacemaker@oss.clusterlabs.org) CRM_DTD_VERSION="1.0" PKG_FEATURES="" HB_PKG=heartbeat AC_CONFIG_AUX_DIR(.) AC_CANONICAL_HOST dnl Where #defines go (e.g. `AC_CHECK_HEADERS' below) dnl dnl Internal header: include/config.h dnl - Contains ALL defines dnl - include/config.h.in is generated automatically by autoheader dnl - NOT to be included in any header files except lha_internal.h dnl (which is also not to be included in any other header files) dnl dnl External header: include/crm_config.h dnl - Contains a subset of defines checked here dnl - Manually edit include/crm_config.h.in to have configure include dnl new defines dnl - Should not include HAVE_* defines dnl - Safe to include anywhere AM_CONFIG_HEADER(include/config.h include/crm_config.h) ALL_LINGUAS="en fr" AC_ARG_WITH(version, [ --with-version=version Override package version (if you're a packager needing to pretend) ], [ PACKAGE_VERSION="$withval" ]) AC_ARG_WITH(pkg-name, [ --with-pkg-name=name Override package name (if you're a packager needing to pretend) ], [ PACKAGE_NAME="$withval" ]) AM_INIT_AUTOMAKE($PACKAGE_NAME, $PACKAGE_VERSION) AC_DEFINE_UNQUOTED(PACEMAKER_VERSION, "$PACKAGE_VERSION", Current pacemaker version) dnl automake >= 1.11 offers --enable-silent-rules for suppressing the output from dnl normal compilation. When a failure occurs, it will then display the full dnl command line dnl Wrap in m4_ifdef to avoid breaking on older platforms m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES]) CC_IN_CONFIGURE=yes export CC_IN_CONFIGURE LDD=ldd dnl ======================================================================== dnl Compiler characteristics dnl ======================================================================== AC_PROG_CC dnl Can force other with environment variable "CC". AM_PROG_CC_C_O AC_PROG_CC_STDC AC_LIBTOOL_DLOPEN dnl Enable dlopen support... AC_LIBLTDL_CONVENIENCE dnl make libltdl a convenience lib AC_PROG_LIBTOOL AC_C_STRINGIZE AC_TYPE_SIZE_T AC_CHECK_SIZEOF(char) AC_CHECK_SIZEOF(short) AC_CHECK_SIZEOF(int) AC_CHECK_SIZEOF(long) AC_CHECK_SIZEOF(long long) AC_STRUCT_TIMEZONE dnl =============================================== dnl Helpers dnl =============================================== cc_supports_flag() { local CFLAGS="$@" AC_MSG_CHECKING(whether $CC supports "$@") AC_COMPILE_IFELSE([int main(){return 0;}] ,[RC=0; AC_MSG_RESULT(yes)],[RC=1; AC_MSG_RESULT(no)]) return $RC } extract_header_define() { AC_MSG_CHECKING(for $2 in $1) Cfile=/tmp/extract_define.$2.${$} printf "#include \n" > ${Cfile}.c printf "#include <%s>\n" $1 >> ${Cfile}.c printf "int main(int argc, char **argv) { printf(\"%%s\", %s); return 0; }\n" $2 >> ${Cfile}.c $CC $CFLAGS ${Cfile}.c -o ${Cfile} value=`${Cfile}` AC_MSG_RESULT($value) printf $value rm -f ${Cfile}.c ${Cfile} } dnl =============================================== dnl Configure Options dnl =============================================== dnl Some systems, like Solaris require a custom package name AC_ARG_WITH(pkgname, [ --with-pkgname=name name for pkg (typically for Solaris) ], [ PKGNAME="$withval" ], [ PKGNAME="LXHAhb" ], ) AC_SUBST(PKGNAME) AC_ARG_ENABLE([ansi], [ --enable-ansi force GCC to compile to ANSI/ANSI standard for older compilers. [default=yes]]) AC_ARG_ENABLE([fatal-warnings], [ --enable-fatal-warnings very pedantic and fatal warnings for gcc [default=yes]]) AC_ARG_ENABLE([pretty], [ --enable-pretty Pretty-print compiler output unless there is an error [default=no]]) AC_ARG_ENABLE([quiet], [ --enable-quiet Supress make output unless there is an error [default=no]]) AC_ARG_ENABLE([thread-safe], [ --enable-thread-safe Enable some client libraries to be thread safe. [default=no]]) AC_ARG_ENABLE([bundled-ltdl], [ --enable-bundled-ltdl Configure, build and install the standalone ltdl library bundled with ${PACKAGE} [default=no]]) LTDL_LIBS="" AC_ARG_WITH(ais, [ --with-ais Support the OpenAIS messaging and membership layer ], [ SUPPORT_AIS=$withval ], [ SUPPORT_AIS=try ], ) AC_ARG_WITH(heartbeat, [ --with-heartbeat Support the Heartbeat messaging and membership layer ], [ SUPPORT_HEARTBEAT=$withval ], [ SUPPORT_HEARTBEAT=try ], ) AC_ARG_WITH(snmp, [ --with-snmp Support the SNMP protocol ], [ SUPPORT_SNMP=$withval ], [ SUPPORT_SNMP=try ], ) AC_ARG_WITH(esmtp, [ --with-esmtp Support the sending mail notifications with the esmtp library ], [ SUPPORT_ESMTP=$withval ], [ SUPPORT_ESMTP=try ], ) AISPREFIX="" AC_ARG_WITH(ais-prefix, [ --with-ais-prefix=DIR Prefix used when OpenAIS was installed [$prefix]], [ AISPREFIX=$withval ], [ AISPREFIX=$prefix ]) LCRSODIR="" AC_ARG_WITH(lcrso-dir, [ --with-lcrso-dir=DIR OpenAIS lcrso files. ], [ LCRSODIR="$withval" ]) INITDIR="" AC_ARG_WITH(initdir, [ --with-initdir=DIR directory for init (rc) scripts [${INITDIR}]], [ INITDIR="$withval" ]) dnl =============================================== dnl General Processing dnl =============================================== AC_SUBST(HB_PKG) INIT_EXT="" echo Our Host OS: $host_os/$host AC_MSG_NOTICE(Sanitizing prefix: ${prefix}) case $prefix in NONE) prefix=/usr;; esac AC_MSG_NOTICE(Sanitizing exec_prefix: ${exec_prefix}) case $exec_prefix in dnl For consistency with Heartbeat, map NONE->$prefix NONE) exec_prefix=$prefix;; prefix) exec_prefix=$prefix;; esac AC_MSG_NOTICE(Sanitizing ais_prefix: ${AISPREFIX}) case $AISPREFIX in dnl For consistency with Heartbeat, map NONE->$prefix NONE) AISPREFIX=$prefix;; prefix) AISPREFIX=$prefix;; esac AC_MSG_NOTICE(Sanitizing INITDIR: ${INITDIR}) case $INITDIR in prefix) INITDIR=$prefix;; "") AC_MSG_CHECKING(which init (rc) directory to use) for initdir in /etc/init.d /etc/rc.d/init.d /sbin/init.d \ /usr/local/etc/rc.d /etc/rc.d do if test -d $initdir then INITDIR=$initdir break fi done AC_MSG_RESULT($INITDIR);; esac AC_SUBST(INITDIR) AC_MSG_NOTICE(Sanitizing libdir: ${libdir}) case $libdir in dnl For consistency with Heartbeat, map NONE->$prefix *prefix*|NONE) AC_MSG_CHECKING(which lib directory to use) for aDir in lib64 lib do trydir="${exec_prefix}/${aDir}" if test -d ${trydir} then libdir=${trydir} break fi done AC_MSG_RESULT($libdir); ;; esac dnl Expand autoconf variables so that we dont end up with '${prefix}' dnl in #defines and python scripts dnl NOTE: Autoconf deliberately leaves them unexpanded to allow dnl make exec_prefix=/foo install dnl No longer being able to do this seems like no great loss to me... eval prefix="`eval echo ${prefix}`" eval exec_prefix="`eval echo ${exec_prefix}`" eval bindir="`eval echo ${bindir}`" eval sbindir="`eval echo ${sbindir}`" eval libexecdir="`eval echo ${libexecdir}`" eval datadir="`eval echo ${datadir}`" eval sysconfdir="`eval echo ${sysconfdir}`" eval sharedstatedir="`eval echo ${sharedstatedir}`" eval localstatedir="`eval echo ${localstatedir}`" eval libdir="`eval echo ${libdir}`" eval includedir="`eval echo ${includedir}`" eval oldincludedir="`eval echo ${oldincludedir}`" eval infodir="`eval echo ${infodir}`" eval mandir="`eval echo ${mandir}`" dnl Home-grown variables eval INITDIR="${INITDIR}" eval docdir="`eval echo ${docdir}`" if test x"${docdir}" = x""; then docdir=${datadir}/doc/${PACKAGE}-${VERSION} #docdir=${datadir}/doc/packages/${PACKAGE} fi AC_SUBST(docdir) for j in prefix exec_prefix bindir sbindir libexecdir datadir sysconfdir \ sharedstatedir localstatedir libdir includedir oldincludedir infodir \ mandir INITDIR docdir do dirname=`eval echo '${'${j}'}'` if test ! -d "$dirname" then AC_MSG_WARN([$j directory ($dirname) does not exist!]) fi done dnl This OS-based decision-making is poor autotools practice; dnl feature-based mechanisms are strongly preferred. dnl dnl So keep this section to a bare minimum; regard as a "necessary evil". case "$host_os" in *bsd*) LIBS="-L/usr/local/lib" CPPFLAGS="$CPPFLAGS -I/usr/local/include" INIT_EXT=".sh" ;; *solaris*) ;; *linux*) AC_DEFINE_UNQUOTED(ON_LINUX, 1, Compiling for Linux platform) CFLAGS="$CFLAGS -I${prefix}/include" ;; darwin*) AC_DEFINE_UNQUOTED(ON_DARWIN, 1, Compiling for Darwin platform) LIBS="$LIBS -L${prefix}/lib" CFLAGS="$CFLAGS -I${prefix}/include" ;; esac dnl Eventually remove this CFLAGS="$CFLAGS -I${prefix}/include/heartbeat" AC_SUBST(INIT_EXT) AC_DEFINE_UNQUOTED(HA_LOG_FACILITY, LOG_DAEMON, Default logging facility) AC_MSG_NOTICE(Host CPU: $host_cpu) case "$host_cpu" in ppc64|powerpc64) case $CFLAGS in *powerpc64*) ;; *) if test "$GCC" = yes; then CFLAGS="$CFLAGS -m64" fi ;; esac esac AC_MSG_CHECKING(which format is needed to print uint64_t) case "$host_cpu" in s390x)U64T="%lu";; *64*) U64T="%lu";; *) U64T="%llu";; esac AC_MSG_RESULT($U64T) AC_DEFINE_UNQUOTED(U64T, "$U64T", Correct printf format for logging uint64_t) AC_CHECK_HEADERS(hb_config.h) AC_CHECK_HEADERS(glue_config.h) GLUE_HEADER=none if test "$ac_cv_header_glue_config_h" = "yes"; then GLUE_HEADER=glue_config.h elif test "$ac_cv_header_hb_config_h" = "yes"; then GLUE_HEADER=hb_config.h else AC_MSG_FAILURE(Core development headers were not found) fi dnl Variables needed for substitution CRM_DTD_DIRECTORY="${datadir}/pacemaker" AC_DEFINE_UNQUOTED(CRM_DTD_DIRECTORY,"$CRM_DTD_DIRECTORY", Location for the Pacemaker Relax-NG Schema) AC_SUBST(CRM_DTD_DIRECTORY) AC_DEFINE_UNQUOTED(CRM_DTD_VERSION,"$CRM_DTD_VERSION", Current version of the Pacemaker Relax-NG Schema) AC_SUBST(CRM_DTD_VERSION) CRM_DAEMON_USER=`extract_header_define $GLUE_HEADER HA_CCMUSER` AC_DEFINE_UNQUOTED(CRM_DAEMON_USER,"$CRM_DAEMON_USER", User to run Pacemaker daemons as) AC_SUBST(CRM_DAEMON_USER) CRM_DAEMON_GROUP=`extract_header_define $GLUE_HEADER HA_APIGROUP` AC_DEFINE_UNQUOTED(CRM_DAEMON_GROUP,"$CRM_DAEMON_GROUP", Group to run Pacemaker daemons as) AC_SUBST(CRM_DAEMON_GROUP) CRM_STATE_DIR=${localstatedir}/run/crm AC_DEFINE_UNQUOTED(CRM_STATE_DIR,"$CRM_STATE_DIR", Where to keep state files and sockets) AC_SUBST(CRM_STATE_DIR) PE_STATE_DIR="${localstatedir}/lib/pengine" AC_DEFINE_UNQUOTED(PE_STATE_DIR,"$PE_STATE_DIR", Where to keep PEngine outputs) AC_SUBST(PE_STATE_DIR) dnl Eventually move out of the heartbeat dir tree and create compatability code CRM_CONFIG_DIR="${localstatedir}/lib/heartbeat/crm" AC_DEFINE_UNQUOTED(CRM_CONFIG_DIR,"$CRM_CONFIG_DIR", Where to keep CIB configuration files) AC_SUBST(CRM_CONFIG_DIR) dnl Eventually move out of the heartbeat dir tree and create symlinks when needed CRM_DAEMON_DIR=`extract_header_define $GLUE_HEADER HA_LIBHBDIR` AC_DEFINE_UNQUOTED(CRM_DAEMON_DIR,"$CRM_DAEMON_DIR", Location for Pacemaker daemons) AC_SUBST(CRM_DAEMON_DIR) dnl Needed so that the AIS plugin can clear out the directory as Heartbeat does HA_STATE_DIR=`extract_header_define $GLUE_HEADER HA_VARRUNDIR` AC_DEFINE_UNQUOTED(HA_STATE_DIR,"$HA_STATE_DIR", Where Heartbeat keeps state files and sockets) AC_SUBST(HA_STATE_DIR) dnl Needed for the location of hostcache in CTS.py HA_VARLIBHBDIR=`extract_header_define $GLUE_HEADER HA_VARLIBHBDIR` AC_SUBST(HA_VARLIBHBDIR) AC_DEFINE_UNQUOTED(UUID_FILE,"$localstatedir/lib/heartbeat/hb_uuid", Location of Heartbeat's UUID file) OCF_ROOT_DIR=`extract_header_define $GLUE_HEADER OCF_ROOT_DIR` if test "X$OCF_ROOT_DIR" = X; then AC_MSG_ERROR(Could not locate OCF directory) fi AC_SUBST(OCF_ROOT_DIR) OCF_RA_DIR=`extract_header_define $GLUE_HEADER OCF_RA_DIR` AC_DEFINE_UNQUOTED(OCF_RA_DIR,"$OCF_RA_DIR", Location for OCF RAs) AC_SUBST(OCF_RA_DIR) dnl Extract this value from glue_config.h once we no longer support anything else STONITH_PLUGIN_DIR="$libdir/stonith/plugins/stonith/" AC_DEFINE_UNQUOTED(STONITH_PLUGIN_DIR,"$STONITH_PLUGIN_DIR", Location for Stonith plugins) AC_SUBST(STONITH_PLUGIN_DIR) AC_PATH_PROGS(HG, hg false) AC_MSG_CHECKING(build version) BUILD_VERSION=unknown if test -f $srcdir/.hg_archival.txt; then BUILD_VERSION=`cat $srcdir/.hg_archival.txt | awk '/node:/ { print $2 }'` elif test -x $HG -a -d .hg; then BUILD_VERSION=`$HG id -itb` if test $? != 0; then BUILD_VERSION=unknown fi fi AC_DEFINE_UNQUOTED(BUILD_VERSION, "$BUILD_VERSION", Build version) AC_MSG_RESULT($BUILD_VERSION) AC_SUBST(BUILD_VERSION) dnl =============================================== dnl Program Paths dnl =============================================== PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin:/usr/local/bin" export PATH dnl Replacing AC_PROG_LIBTOOL with AC_CHECK_PROG because LIBTOOL dnl was NOT being expanded all the time thus causing things to fail. AC_CHECK_PROGS(LIBTOOL, glibtool libtool libtool15 libtool13) AM_PATH_PYTHON AC_CHECK_PROGS(MAKE, gmake make) AC_PATH_PROGS(HTML2TXT, lynx w3m) AC_PATH_PROGS(HELP2MAN, help2man) AC_PATH_PROGS(POD2MAN, pod2man, pod2man) AC_PATH_PROGS(ASCIIDOC, asciidoc) +AC_PATH_PROGS(PUBLICAN, publican) AC_PATH_PROGS(FOP, fop) AC_PATH_PROGS(SSH, ssh, /usr/bin/ssh) AC_PATH_PROGS(SCP, scp, /usr/bin/scp) AC_PATH_PROGS(HG, hg, /bin/false) AC_PATH_PROGS(TAR, tar) AC_PATH_PROGS(MD5, md5) AC_PATH_PROGS(TEST, test) AC_PATH_PROGS(PKGCONFIG, pkg-config) AC_PATH_PROGS(XML2CONFIG, xml2-config) AC_PATH_PROGS(VALGRIND_BIN, valgrind, /usr/bin/valgrind) AC_DEFINE_UNQUOTED(VALGRIND_BIN, "$VALGRIND_BIN", Valgrind command) if test x"${LIBTOOL}" = x""; then AC_MSG_ERROR(You need (g)libtool installed in order to build ${PACKAGE}) fi if test x"${MAKE}" = x""; then AC_MSG_ERROR(You need (g)make installed in order to build ${PACKAGE}) fi AM_CONDITIONAL(BUILD_HELP, test x"${HELP2MAN}" != x"") if test x"${HELP2MAN}" != x""; then PKG_FEATURES="$PKG_FEATURES manpages" fi AM_CONDITIONAL(BUILD_ASCIIDOC, test x"${ASCIIDOC}" != x"") if test x"${ASCIIDOC}" != x""; then PKG_FEATURES="$PKG_FEATURES asciidoc" fi -AM_CONDITIONAL(BUILD_FOP, test x"${FOP}" != x"") -if test x"${FOP}" != x""; then - PKG_FEATURES="$PKG_FEATURES pdf" -fi - -XSLT_CHUNKS=`find ${datadir} -name chunk.xsl | wc -l` -AM_CONDITIONAL(BUILD_DOCBOOK, test ${XSLT_CHUNKS} -gt 0) -if test ${XSLT_CHUNKS} -gt 0; then - PKG_FEATURES="$PKG_FEATURES docbook" +AM_CONDITIONAL(BUILD_DOCBOOK, test ${PUBLICAN} != x"") +if test ${PUBLICAN} != x""; then + PKG_FEATURES="$PKG_FEATURES publican" fi dnl =============================================== dnl Libraries dnl =============================================== AC_CHECK_LIB(socket, socket) dnl -lsocket AC_CHECK_LIB(c, dlopen) dnl if dlopen is in libc... AC_CHECK_LIB(dl, dlopen) dnl -ldl (for Linux) AC_CHECK_LIB(rt, sched_getscheduler) dnl -lrt (for Tru64) AC_CHECK_LIB(gnugetopt, getopt_long) dnl -lgnugetopt ( if available ) AC_CHECK_LIB(pam, pam_start) dnl -lpam (if available) AC_CHECK_LIB(uuid, uuid_parse) dnl e2fsprogs AC_CHECK_LIB(uuid, uuid_create) dnl ossp if test x"${PKGCONFIG}" = x""; then AC_MSG_ERROR(You need pkgconfig installed in order to build ${PACKAGE}) fi dnl dnl On many systems libcrypto is needed when linking against libsnmp. dnl Check to see if it exists, and if so use it. dnl AC_CHECK_LIB(crypto, CRYPTO_free, CRYPTOLIB="-lcrypto",) AC_SUBST(CRYPTOLIB) if test "x${enable_thread_safe}" = "xyes"; then GPKGNAME="gthread-2.0" else GPKGNAME="glib-2.0" fi if $PKGCONFIG --exists $GPKGNAME then GLIBCONFIG="$PKGCONFIG $GPKGNAME" else set -x echo PKG_CONFIG_PATH=$PKG_CONFIG_PATH $PKGCONFIG --exists $GPKGNAME; echo $? $PKGCONFIG --cflags $GPKGNAME; echo $? $PKGCONFIG $GPKGNAME; echo $? set +x AC_MSG_ERROR(You need glib2-devel installed in order to build ${PACKAGE}) fi AC_MSG_RESULT(using $GLIBCONFIG) # # Where is dlopen? # if test "$ac_cv_lib_c_dlopen" = yes; then LIBADD_DL="" elif test "$ac_cv_lib_dl_dlopen" = yes; then LIBADD_DL=-ldl else LIBADD_DL=${lt_cv_dlopen_libs} fi dnl dnl Check for location of gettext dnl dnl On at least Solaris 2.x, where it is in libc, specifying lintl causes dnl grief. Ensure minimal result, not the sum of all possibilities. dnl And do libc first. dnl Known examples: dnl c: Linux, Solaris 2.6+ dnl intl: BSD, AIX AC_CHECK_LIB(c, gettext) if test x$ac_cv_lib_c_gettext != xyes; then AC_CHECK_LIB(intl, gettext) fi if test x$ac_cv_lib_c_gettext != xyes -a x$ac_cv_lib_intl_gettext != xyes; then AC_MSG_ERROR(You need gettext installed in order to build ${PACKAGE}) fi if test "X$GLIBCONFIG" != X; then AC_MSG_CHECKING(for special glib includes: ) GLIBHEAD=`$GLIBCONFIG --cflags` AC_MSG_RESULT($GLIBHEAD) CPPFLAGS="$CPPFLAGS $GLIBHEAD" AC_MSG_CHECKING(for glib library flags) GLIBLIB=`$GLIBCONFIG --libs` AC_MSG_RESULT($GLIBLIB) LIBS="$LIBS $GLIBLIB" fi dnl ======================================================================== dnl Headers dnl ======================================================================== AC_HEADER_STDC AC_CHECK_HEADERS(arpa/inet.h) AC_CHECK_HEADERS(asm/types.h) AC_CHECK_HEADERS(assert.h) AC_CHECK_HEADERS(auth-client.h) AC_CHECK_HEADERS(ctype.h) AC_CHECK_HEADERS(dirent.h) AC_CHECK_HEADERS(errno.h) AC_CHECK_HEADERS(fcntl.h) AC_CHECK_HEADERS(getopt.h) AC_CHECK_HEADERS(glib.h) AC_CHECK_HEADERS(grp.h) AC_CHECK_HEADERS(limits.h) AC_CHECK_HEADERS(linux/errqueue.h) AC_CHECK_HEADERS(malloc.h) AC_CHECK_HEADERS(netdb.h) AC_CHECK_HEADERS(netinet/in.h) AC_CHECK_HEADERS(netinet/ip.h) AC_CHECK_HEADERS(pam/pam_appl.h) AC_CHECK_HEADERS(pthread.h) AC_CHECK_HEADERS(pwd.h) AC_CHECK_HEADERS(security/pam_appl.h) AC_CHECK_HEADERS(sgtty.h) AC_CHECK_HEADERS(signal.h) AC_CHECK_HEADERS(stdarg.h) AC_CHECK_HEADERS(stddef.h) AC_CHECK_HEADERS(stdio.h) AC_CHECK_HEADERS(stdlib.h) AC_CHECK_HEADERS(string.h) AC_CHECK_HEADERS(strings.h) AC_CHECK_HEADERS(sys/dir.h) AC_CHECK_HEADERS(sys/ioctl.h) AC_CHECK_HEADERS(sys/param.h) AC_CHECK_HEADERS(sys/poll.h) AC_CHECK_HEADERS(sys/resource.h) AC_CHECK_HEADERS(sys/select.h) AC_CHECK_HEADERS(sys/socket.h) AC_CHECK_HEADERS(sys/sockio.h) AC_CHECK_HEADERS(sys/stat.h) AC_CHECK_HEADERS(sys/time.h) AC_CHECK_HEADERS(sys/timeb.h) AC_CHECK_HEADERS(sys/types.h) AC_CHECK_HEADERS(sys/uio.h) AC_CHECK_HEADERS(sys/un.h) AC_CHECK_HEADERS(sys/utsname.h) AC_CHECK_HEADERS(sys/wait.h) AC_CHECK_HEADERS(time.h) AC_CHECK_HEADERS(unistd.h) AC_CHECK_HEADERS(winsock.h) dnl These headers need prerequisits before the tests will pass dnl AC_CHECK_HEADERS(net/if.h) dnl AC_CHECK_HEADERS(netinet/icmp6.h) dnl AC_CHECK_HEADERS(netinet/ip6.h) dnl AC_CHECK_HEADERS(netinet/ip_icmp.h) AC_MSG_CHECKING(for special libxml2 includes) if test "x$XML2CONFIG" = "x"; then AC_MSG_ERROR(libxml2 config not found) else XML2HEAD="`$XML2CONFIG --cflags`" AC_MSG_RESULT($XML2HEAD) AC_CHECK_LIB(xml2, xmlReadMemory) AC_CHECK_LIB(xslt, xsltApplyStylesheet) fi CPPFLAGS="$CPPFLAGS $XML2HEAD" AC_CHECK_HEADERS(libxml/xpath.h) AC_CHECK_HEADERS(libxslt/xslt.h) if test "$ac_cv_header_libxml_xpath_h" != "yes"; then AC_MSG_ERROR(The libxml developement headers were not found) fi if test "$ac_cv_header_libxslt_xslt_h" != "yes"; then AC_MSG_ERROR(The libxslt developement headers were not found) fi dnl ======================================================================== dnl Structures dnl ======================================================================== AC_CHECK_MEMBERS([struct tm.tm_gmtoff],,,[[#include ]]) dnl ======================================================================== dnl Functions dnl ======================================================================== AC_CHECK_FUNCS(g_log_set_default_handler) AC_CHECK_FUNCS(getopt, AC_DEFINE(HAVE_DECL_GETOPT, 1, [Have getopt function])) dnl ======================================================================== dnl ltdl dnl ======================================================================== AC_CHECK_LIB(ltdl, lt_dlopen, [LTDL_foo=1]) if test "x${enable_bundled_ltdl}" = "xyes"; then if test $ac_cv_lib_ltdl_lt_dlopen = yes; then AC_MSG_NOTICE([Disabling usage of installed ltdl]) fi ac_cv_lib_ltdl_lt_dlopen=no fi LIBLTDL_DIR="" if test $ac_cv_lib_ltdl_lt_dlopen != yes ; then AC_MSG_NOTICE([Installing local ltdl]) LIBLTDL_DIR=libltdl ( cd $srcdir ; $TAR -xvf libltdl.tar ) if test "$?" -ne 0; then AC_MSG_ERROR([$TAR of libltdl.tar in $srcdir failed]) fi AC_CONFIG_SUBDIRS(libltdl) else LIBS="$LIBS -lltdl" AC_MSG_NOTICE([Using installed ltdl]) INCLTDL="" LIBLTDL="" fi AC_SUBST(INCLTDL) AC_SUBST(LIBLTDL) AC_SUBST(LIBLTDL_DIR) dnl ======================================================================== dnl bzip2 dnl ======================================================================== AC_CHECK_HEADERS(bzlib.h) AC_CHECK_LIB(bz2, BZ2_bzBuffToBuffCompress) if test x$ac_cv_lib_bz2_BZ2_bzBuffToBuffCompress != xyes ; then AC_MSG_ERROR(BZ2 libraries not found) fi if test x$ac_cv_header_bzlib_h != xyes; then AC_MSG_ERROR(BZ2 Development headers not found) fi dnl ======================================================================== dnl ncurses dnl ======================================================================== dnl dnl A few OSes (e.g. Linux) deliver a default "ncurses" alongside "curses". dnl Many non-Linux deliver "curses"; sites may add "ncurses". dnl dnl However, the source-code recommendation for both is to #include "curses.h" dnl (i.e. "ncurses" still wants the include to be simple, no-'n', "curses.h"). dnl dnl ncurse takes precedence. dnl AC_CHECK_HEADERS(curses.h) AC_CHECK_HEADERS(curses/curses.h) AC_CHECK_HEADERS(ncurses.h) AC_CHECK_HEADERS(ncurses/ncurses.h) dnl Although n-library is preferred, only look for it if the n-header was found. CURSESLIBS='' if test "$ac_cv_header_ncurses_h" = "yes"; then AC_CHECK_LIB(ncurses, printw, [CURSESLIBS='-lncurses'; AC_DEFINE(HAVE_LIBNCURSES,1, have ncurses library)] ) fi if test "$ac_cv_header_ncurses_ncurses_h" = "yes"; then AC_CHECK_LIB(ncurses, printw, [CURSESLIBS='-lncurses'; AC_DEFINE(HAVE_LIBNCURSES,1, have ncurses library)] ) fi dnl Only look for non-n-library if there was no n-library. if test X"$CURSESLIBS" = X"" -a "$ac_cv_header_curses_h" = "yes"; then AC_CHECK_LIB(curses, printw, [CURSESLIBS='-lcurses'; AC_DEFINE(HAVE_LIBCURSES,1, have curses library)] ) fi dnl Only look for non-n-library if there was no n-library. if test X"$CURSESLIBS" = X"" -a "$ac_cv_header_curses_curses_h" = "yes"; then AC_CHECK_LIB(curses, printw, [CURSESLIBS='-lcurses'; AC_DEFINE(HAVE_LIBCURSES,1, have curses library)] ) fi if test "x$CURSESLIBS" != "x"; then PKG_FEATURES="$PKG_FEATURES ncurses" fi dnl Check for printw() prototype compatibility if test X"$CURSESLIBS" != X"" && cc_supports_flag -Wcast-qual && cc_supports_flag -Werror; then AC_MSG_CHECKING(whether printw() requires argument of "const char *") ac_save_LIBS=$LIBS LIBS="$CURSESLIBS $LIBS" ac_save_CFLAGS=$CFLAGS CFLAGS="-Wcast-qual -Werror" AC_LINK_IFELSE( [AC_LANG_PROGRAM( [ #if defined(HAVE_CURSES_H) # include #elif defined(HAVE_NCURSES_H) # include #endif ], [printw((const char *)"Test");] )], [ac_cv_compatible_printw=yes], [ac_cv_compatible_printw=no] ) LIBS=$ac_save_LIBS CFLAGS=$ac_save_CFLAGS AC_MSG_RESULT([$ac_cv_compatible_printw]) if test "$ac_cv_compatible_printw" = no; then AC_MSG_WARN([The printw() function of your ncurses or curses library is old, we will disable usage of the library. If you want to use this library anyway, please update to newer version of the library, ncurses 5.4 or later is recommended. You can get the library from http://www.gnu.org/software/ncurses/.]) AC_MSG_NOTICE([Disabling curses]) AC_DEFINE(HAVE_INCOMPATIBLE_PRINTW, 1, [Do we have incompatible printw() in curses library?]) fi fi AC_SUBST(CURSESLIBS) dnl ======================================================================== dnl Cluster infrastructure - Heartbeat dnl ======================================================================== dnl On Debian, AC_CHECK_LIBS fail if a library has any unresolved symbols dnl So check for all the depenancies (so they're added to LIBS) before checking for -lplumb AC_CHECK_LIB(pils, PILLoadPlugin) AC_CHECK_LIB(plumb, G_main_add_IPC_Channel) if test x"$ac_cv_lib_plumb_G_main_add_IPC_Channel" != x"yes"; then AC_MSG_FAILURE(Core Heartbeat utility libraries not found: $ac_cv_lib_plumb_G_main_add_IPC_Channel) fi dnl Compatability checks AC_CHECK_FUNCS(msgfromIPC_timeout) AC_CHECK_MEMBERS([struct lrm_ops.fail_rsc],,,[[#include ]]) dnl ======================================================================== dnl Cluster stack - Heartbeat dnl ======================================================================== case $SUPPORT_HEARTBEAT in 1|yes|true) AC_CHECK_LIB(hbclient, ll_cluster_new, [SUPPORT_HEARTBEAT=1], [AC_MSG_FAILURE(Unable to support Heartbeat: client libraries not found)]);; try) AC_CHECK_LIB(hbclient, ll_cluster_new, [SUPPORT_HEARTBEAT=1], [SUPPORT_HEARTBEAT=0]);; *) SUPPORT_HEARTBEAT=0;; esac AM_CONDITIONAL(BUILD_HEARTBEAT_SUPPORT, test $SUPPORT_HEARTBEAT = 1) AC_DEFINE_UNQUOTED(SUPPORT_HEARTBEAT, $SUPPORT_HEARTBEAT, Support the Heartbeat messaging and membership layer) dnl ======================================================================== dnl Cluster stack - OpenAIS dnl ======================================================================== AISLIB="" dnl Normalize the values case $SUPPORT_AIS in 1|yes|true) missingisfatal=1;; try) missingisfatal=0;; *) SUPPORT_AIS=no;; esac AC_MSG_CHECKING(for native AIS) AISMSGLIB="" AIS_VERSION="none" COROSYNC_PKG="$PKGCONFIG libcoroipcc" if test $SUPPORT_AIS = no; then AC_MSG_RESULT(no... not requested.) else AC_MSG_RESULT($SUPPORT_AIS, with '$AISPREFIX') AC_CHECK_HEADERS(openais/saAis.h) AC_CHECK_HEADERS(corosync/coroipcc.h) $COROSYNC_PKG --exists if test $? = 0; then AIS_VERSION="corosync" elif test "$ac_cv_header_openais_saAis_h" = "yes"; then AIS_VERSION="whitetank" else aisreason="Whitetank headers not found" fi fi if test $AIS_VERSION != "none"; then AC_MSG_CHECKING(for OpenAIS branch) AC_MSG_RESULT($AIS_VERSION) fi if test $AIS_VERSION = "corosync"; then if test "$ac_cv_header_corosync_coroipcc_h" != "yes"; then AIS_VERSION="none" aisreason="Corosync headers not found" fi saveLIBS="$LIBS" LIBS="$LIBS `$COROSYNC_PKG --libs-only-L`" AC_CHECK_LIB(coroipcc, coroipcc_msg_send_reply_receive, []) LIBS="$saveLIBS" if test $ac_cv_lib_coroipcc_coroipcc_msg_send_reply_receive != yes; then AC_MSG_RESULT(Cannot locate AIS messaging library) aisreason="requred Corosync libraries not found" AIS_VERSION="none" fi fi dnl continue? if test $AIS_VERSION = "whitetank"; then dnl Find it in lib, lib64, or wherever it wants to live... AC_MSG_CHECKING(location of OpenAIS libraries) dnl CoroSync location alib=`ls ${AISPREFIX}/*/libcpg.so | head -n 1` if test -z "$alib"; then dnl Whitetank location alib=`ls ${AISPREFIX}/*/*/libcpg.so | head -n 1` fi AISLIB=`dirname $alib` AC_MSG_RESULT($AISLIB) if test "x$AISLIB" = "x"; then AC_MSG_WARN(Use --with-ais-prefix to specify the prefix OpenAIS was installed with) aisreason="library directory not found" AIS_VERSION="none" elif test ! -d "$AISLIB"; then AC_MSG_WARN(Use --with-ais-prefix to specify the prefix OpenAIS was installed with) aisreason="specified library directory does not exist" AIS_VERSION="none" fi fi dnl continue? if test $AIS_VERSION = "whitetank"; then AC_MSG_CHECKING(location of OpenAIS plugins) if test -z "$LCRSODIR"; then LCRSODIR="$libexecdir/lcrso" alib=`ls ${AISPREFIX}/*/lcrso/objdb.lcrso | head -n 1` LCRSODIR=`dirname $alib` fi AC_MSG_RESULT($LCRSODIR) if test "x$LCRSODIR" = "x"; then AC_MSG_RESULT(Invalid. Please specify the correct location with --with-lcrso-dir) aisreason="plugin directory not found" AIS_VERSION="none" elif test ! -d "$LCRSODIR"; then AC_MSG_RESULT(Invalid. Please specify the correct location with --with-lcrso-dir) aisreason="specified plugin directory does not exist" AIS_VERSION="none" fi fi dnl continue? if test $AIS_VERSION = "whitetank"; then dnl Don't add the messaging library to LIBS since most daemons don't need/use it saveLIBS="$LIBS" LIBS="$LIBS -L${AISLIB} -R${AISLIB}" AC_CHECK_LIB(SaMsg, saSendReceiveReply, []) AC_CHECK_LIB(SaMsg, openais_msg_send_reply_receive, []) if test $ac_cv_lib_SaMsg_openais_msg_send_reply_receive = yes; then : OpenAIS elif test $ac_cv_lib_SaMsg_saSendReceiveReply = yes; then : OpenAIS AC_DEFINE_UNQUOTED(TRADITIONAL_AIS_IPC, 1, "Use the 'old' AIS IPC interface") else AC_MSG_RESULT(Cannot locate AIS messaging library) aisreason="requred libraries not found" AIS_VERSION="none" fi LIBS="$saveLIBS" fi SUPPORT_AIS=1 case $AIS_VERSION in corosync) AC_DEFINE_UNQUOTED(AIS_COROSYNC, 1, "AIS target is the corosync series") LCRSODIR=`$PKGCONFIG corosync --variable=lcrsodir` CFLAGS="$CFLAGS `$COROSYNC_PKG --cflags`" AISMSGLIB=`$COROSYNC_PKG --libs` ;; whitetank) AC_DEFINE_UNQUOTED(AIS_WHITETANK, 1, "AIS target is the whitetank series") CFLAGS="$CFLAGS -I$AISPREFIX/include/openais" AISMSGLIB="-L${AISLIB} -R${AISLIB} -lSaMsg" ;; none) SUPPORT_AIS=0 if test "x$aisreason" != x; then if test $missingisfatal = 0; then AC_MSG_WARN(Unable to support OpenAIS: $aisreason) else AC_MSG_FAILURE(Unable to support OpenAIS: $aisreason) fi fi ;; *) AC_MSG_FAILURE(Unknown OpenAIS branch: $AIS_VERSION);; esac AC_DEFINE_UNQUOTED(SUPPORT_AIS, $SUPPORT_AIS, Support the OpenAIS messaging and membership layer) AM_CONDITIONAL(BUILD_AIS_SUPPORT, test $SUPPORT_AIS = 1) dnl dnl Cluster stack - Sanity dnl STACKS="" CLUSTERLIBS="" if test $SUPPORT_HEARTBEAT = 1; then STACKS="$STACKS heartbeat" CLUSTERLIBS="$CLUSTERLIBS -lhbclient -lccmclient" fi if test $SUPPORT_AIS = 1; then STACKS="$STACKS $AIS_VERSION" CLUSTERLIBS="$CLUSTERLIBS ${AISMSGLIB}" else AISPREFIX="" LCRSODIR="$libdir" fi PKG_FEATURES="$PKG_FEATURES$STACKS" AC_MSG_CHECKING(for supported stacks) if test x"$STACKS" = x; then AC_MSG_FAILURE(You must choose at least one cluster stack to support) fi AC_MSG_RESULT($STACKS) AC_SUBST(CLUSTERLIBS) AC_SUBST(LCRSODIR) dnl ======================================================================== dnl SNMP dnl ======================================================================== case $SUPPORT_SNMP in 1|yes|true) missingisfatal=1;; try) missingisfatal=0;; *) SUPPORT_SNMP=no;; esac SNMPLIB="" AC_MSG_CHECKING(for snmp support) if test $SUPPORT_SNMP = no; then AC_MSG_RESULT(no... not requested.) SUPPORT_SNMP=0 else SNMPCONFIG="" AC_MSG_RESULT($SUPPORT_SNMP) AC_CHECK_HEADERS(net-snmp/net-snmp-config.h) if test "x${ac_cv_header_net_snmp_net_snmp_config_h}" != "xyes"; then SUPPORT_SNMP="no" fi if test $SUPPORT_SNMP != no; then AC_PATH_PROGS(SNMPCONFIG, net-snmp-config) if test "X${SNMPCONFIG}" = "X"; then AC_MSG_RESULT(You need the net_snmp development package to continue.) SUPPORT_SNMP=no fi fi if test $SUPPORT_SNMP != no; then AC_MSG_CHECKING(for special snmp libraries) SNMPLIBS=`$SNMPCONFIG --agent-libs` AC_MSG_RESULT($SNMPLIBS) fi if test $SUPPORT_SNMP != no; then savedLibs=$LIBS LIBS="$LIBS $SNMPLIBS" AC_CHECK_FUNCS(netsnmp_transport_open_client) if test $ac_cv_func_netsnmp_transport_open_client != yes; then SUPPORT_SNMP=no fi LIBS=$savedLibs fi if test $SUPPORT_SNMP = no; then SUPPORT_SNMP=0 if test $missingisfatal = 0; then AC_MSG_WARN(Unable to support SNMP) else AC_MSG_FAILURE(Unable to support SNMP) fi else SUPPORT_SNMP=1 fi fi if test $SUPPORT_SNMP = 1; then PKG_FEATURES="$PKG_FEATURES snmp" fi AC_SUBST(SNMPLIBS) AM_CONDITIONAL(ENABLE_SNMP, test "$SUPPORT_SNMP" = "1") AC_DEFINE_UNQUOTED(ENABLE_SNMP, $SUPPORT_SNMP, Build in support for sending SNMP traps) dnl ======================================================================== dnl ESMTP dnl ======================================================================== case $SUPPORT_ESMTP in 1|yes|true) missingisfatal=1;; try) missingisfatal=0;; *) SUPPORT_ESMTP=no;; esac ESMTPLIB="" AC_MSG_CHECKING(for esmtp support) if test $SUPPORT_ESMTP = no; then AC_MSG_RESULT(no... not requested.) SUPPORT_ESMTP=0 else ESMTPCONFIG="" AC_MSG_RESULT($SUPPORT_ESMTP) AC_CHECK_HEADERS(libesmtp.h) if test "x${ac_cv_header_libesmtp_h}" != "xyes"; then ENABLE_ESMTP="no" fi if test $SUPPORT_ESMTP != no; then AC_PATH_PROGS(ESMTPCONFIG, libesmtp-config) if test "X${ESMTPCONFIG}" = "X"; then AC_MSG_RESULT(You need the libesmtp development package to continue.) SUPPORT_ESMTP=no fi fi if test $SUPPORT_ESMTP != no; then AC_MSG_CHECKING(for special esmtp libraries) ESMTPLIBS=`$ESMTPCONFIG --libs | tr '\n' ' '` AC_MSG_RESULT($ESMTPLIBS) fi if test $SUPPORT_ESMTP = no; then SUPPORT_ESMTP=0 if test $missingisfatal = 0; then AC_MSG_WARN(Unable to support ESMTP) else AC_MSG_FAILURE(Unable to support ESMTP) fi else SUPPORT_ESMTP=1 fi fi if test $SUPPORT_ESMTP = 1; then PKG_FEATURES="$PKG_FEATURES libesmtp" fi AC_SUBST(ESMTPLIBS) AM_CONDITIONAL(ENABLE_ESMTP, test "$SUPPORT_ESMTP" = "1") AC_DEFINE_UNQUOTED(ENABLE_ESMTP, $SUPPORT_ESMTP, Build in support for sending mail notifications with ESMTP) dnl ======================================================================== dnl GnuTLS dnl ======================================================================== AC_CHECK_HEADERS(gnutls/gnutls.h) AC_CHECK_HEADERS(security/pam_appl.h pam/pam_appl.h) dnl GNUTLS library: Attempt to determine by 'libgnutls-config' program. dnl If no 'libgnutls-config', try traditional autoconf means. AC_PATH_PROGS(LIBGNUTLS_CONFIG, libgnutls-config) if test -n "$LIBGNUTLS_CONFIG"; then AC_MSG_CHECKING(for gnutls header flags) GNUTLSHEAD="`$LIBGNUTLS_CONFIG --cflags`"; AC_MSG_RESULT($GNUTLSHEAD) AC_MSG_CHECKING(for gnutls library flags) GNUTLSLIBS="`$LIBGNUTLS_CONFIG --libs`"; AC_MSG_RESULT($GNUTLSLIBS) else AC_CHECK_LIB(gnutls, gnutls_init) fi AC_SUBST(GNUTLSHEAD) AC_SUBST(GNUTLSLIBS) dnl ======================================================================== dnl System Health dnl ======================================================================== dnl Check if servicelog development package is installed SERVICELOG=servicelog-1 SERVICELOG_EXISTS="no" AC_MSG_CHECKING(for $SERVICELOG packages) if $PKGCONFIG --exists $SERVICELOG then SERVICELOG_EXISTS="yes" fi AC_MSG_RESULT($SERVICELOG_EXISTS) AM_CONDITIONAL(BUILD_SERVICELOG, test "$SERVICELOG_EXISTS" = "yes") dnl Check if OpenIMPI packages and servicelog are installed OPENIPMI="OpenIPMI OpenIPMIposix" OPENIPMI_SERVICELOG_EXISTS="no" AC_MSG_CHECKING(for $SERVICELOG $OPENIPMI packages) if $PKGCONFIG --exists $OPENIPMI $SERVICELOG then OPENIPMI_SERICELOG_EXISTS="yes" fi AC_MSG_RESULT($OPENIPMI_SERICELOG_EXISTS) AM_CONDITIONAL(BUILD_OPENIPMI_SERICELOG, test "$OPENIPMI_SERICELOG_EXISTS" = "yes") dnl ======================================================================== dnl checks for library functions to replace them dnl dnl NoSuchFunctionName: dnl is a dummy function which no system supplies. It is here to make dnl the system compile semi-correctly on OpenBSD which doesn't know dnl how to create an empty archive dnl dnl scandir: Only on BSD. dnl System-V systems may have it, but hidden and/or deprecated. dnl A replacement function is supplied for it. dnl dnl setenv: is some bsdish function that should also be avoided (use dnl putenv instead) dnl On the other hand, putenv doesn't provide the right API for the dnl code and has memory leaks designed in (sigh...) Fortunately this dnl A replacement function is supplied for it. dnl dnl strerror: returns a string that corresponds to an errno. dnl A replacement function is supplied for it. dnl dnl unsetenv: is some bsdish function that should also be avoided (No dnl replacement) dnl A replacement function is supplied for it. dnl dnl strnlen: is a gnu function similar to strlen, but safer. dnl We wrote a tolearably-fast replacement function for it. dnl dnl strndup: is a gnu function similar to strdup, but safer. dnl We wrote a tolearably-fast replacement function for it. dnl dnl daemon: is a GNU function. The daemon() function is for programs wishing to dnl detach themselves from the controlling terminal and run in the dnl background as system daemon dnl A replacement function is supplied for it. AC_REPLACE_FUNCS(alphasort inet_pton NoSuchFunctionName scandir setenv strerror unsetenv strnlen strndup daemon strlcpy strlcat) dnl ======================================================================== dnl Compiler flags dnl ======================================================================== dnl Make sure that CFLAGS is not exported. If the user did dnl not have CFLAGS in their environment then this should have dnl no effect. However if CFLAGS was exported from the user's dnl environment, then the new CFLAGS will also be exported dnl to sub processes. CC_ERRORS="" CC_EXTRAS="" if export | fgrep " CFLAGS=" > /dev/null; then export -n CFLAGS || true # We don't want to bomb out if this fails fi if test "$GCC" != yes; then CFLAGS="$CFLAGS -g" enable_fatal_warnings=no else CFLAGS="$CFLAGS -ggdb3 -O0" # We had to eliminate -Wnested-externs because of libtool changes EXTRA_FLAGS="-fgnu89-inline -fstack-protector-all -Wall -Waggregate-return -Wbad-function-cast -Wcast-qual -Wcast-align -Wdeclaration-after-statement -Wendif-labels -Wfloat-equal -Wformat=2 -Wformat-security -Wformat-nonliteral -Winline -Wmissing-prototypes -Wmissing-declarations -Wnested-externs -Wno-long-long -Wno-strict-aliasing -Wpointer-arith -Wstrict-prototypes -Wunsigned-char -Wwrite-strings" # Additional warnings it might be nice to enable one day # -Wshadow # -Wunreachable-code for j in $EXTRA_FLAGS do if cc_supports_flag $j then CC_EXTRAS="$CC_EXTRAS $j" fi done dnl In lib/ais/Makefile.am there's a gcc option available as of v4.x GCC_MAJOR=`gcc -v 2>&1 | awk 'END{print $3}' | sed 's/[.].*//'` AM_CONDITIONAL(GCC_4, test "${GCC_MAJOR}" = 4) dnl System specific options case "$host_os" in *linux*|*bsd*) if test "${enable_fatal_warnings}" = "unknown"; then enable_fatal_warnings=yes fi ;; esac if test "x${enable_fatal_warnings}" != xno && cc_supports_flag -Werror ; then enable_fatal_warnings=yes else enable_fatal_warnings=no fi if test "x${enable_ansi}" != xno && cc_supports_flag -std=iso9899:199409 ; then AC_MSG_NOTICE(Enabling ANSI Compatibility) CC_EXTRAS="$CC_EXTRAS -ansi -D_GNU_SOURCE -DANSI_ONLY" fi AC_MSG_NOTICE(Activated additional gcc flags: ${CC_EXTRAS}) fi CFLAGS="$CFLAGS $CC_EXTRAS" NON_FATAL_CFLAGS="$CFLAGS" AC_SUBST(NON_FATAL_CFLAGS) dnl dnl We reset CFLAGS to include our warnings *after* all function dnl checking goes on, so that our warning flags don't keep the dnl AC_*FUNCS() calls above from working. In particular, -Werror will dnl *always* cause us troubles if we set it before here. dnl dnl if test "x${enable_fatal_warnings}" = xyes ; then AC_MSG_NOTICE(Enabling Fatal Warnings) CFLAGS="$CFLAGS -Werror" fi AC_SUBST(CFLAGS) dnl This is useful for use in Makefiles that need to remove one specific flag CFLAGS_COPY="$CFLAGS" AC_SUBST(CFLAGS_COPY) AC_SUBST(LIBADD_DL) dnl extra flags for dynamic linking libraries AC_SUBST(LIBADD_INTL) dnl extra flags for GNU gettext stuff... AC_SUBST(LOCALE) dnl Options for cleaning up the compiler output QUIET_LIBTOOL_OPTS="" QUIET_MAKE_OPTS="" if test "x${enable_quiet}" = "xyes"; then QUIET_LIBTOOL_OPTS="--quiet" QUIET_MAKE_OPTS="--quiet" fi AC_MSG_RESULT(Supress make details: ${enable_quiet}) dnl Put the above variables to use LIBTOOL="${LIBTOOL} --tag=CC \$(QUIET_LIBTOOL_OPTS)" MAKE="${MAKE} \$(QUIET_MAKE_OPTS)" AC_SUBST(CC) AC_SUBST(MAKE) AC_SUBST(LIBTOOL) AC_SUBST(QUIET_MAKE_OPTS) AC_SUBST(QUIET_LIBTOOL_OPTS) dnl The Makefiles and shell scripts we output AC_CONFIG_FILES(Makefile \ README \ cts/Makefile \ cts/CTSvars.py \ cts/LSBDummy \ cib/Makefile \ crmd/Makefile \ pengine/Makefile \ debian/Makefile \ doc/Makefile \ doc/cibadmin.8 \ doc/crm_resource.8 \ include/Makefile \ include/crm/Makefile \ include/crm/common/Makefile \ include/crm/pengine/Makefile \ include/fencing/Makefile \ replace/Makefile \ lib/Makefile \ lib/ais/Makefile \ lib/common/Makefile \ lib/cib/Makefile \ lib/pengine/Makefile \ lib/transition/Makefile \ lib/fencing/Makefile \ lib/plugins/Makefile \ lib/plugins/lrm/Makefile \ fencing/Makefile \ fencing/stonithd/Makefile \ fencing/test/Makefile \ fencing/test/STONITHDBasicSanityCheck \ extra/Makefile \ extra/resources/Makefile \ tools/Makefile \ tools/haresources2cib.py \ tools/hb2openais.sh \ tools/crm_primitive.py \ tools/crm \ tools/shell/Makefile \ tools/shell/templates/Makefile \ tools/shell/regression/Makefile \ tools/shell/regression/regression.sh \ tools/shell/regression/lrmregtest-lsb \ tools/shell/regression/testcases/Makefile \ xml/Makefile \ xml/pacemaker.rng \ xml/resources.rng \ xml/constraints.rng \ xml/rule.rng \ xml/nvset.rng \ ) dnl Now process the entire list of files added by previous dnl calls to AC_CONFIG_FILES() AC_OUTPUT() dnl ***************** dnl Configure summary dnl ***************** AC_MSG_RESULT([]) AC_MSG_RESULT([$PACKAGE configuration:]) AC_MSG_RESULT([ Version = ${VERSION} (Build: $BUILD_VERSION)]) AC_MSG_RESULT([ Features =${PKG_FEATURES}]) AC_MSG_RESULT([]) AC_MSG_RESULT([ Prefix = ${prefix}]) AC_MSG_RESULT([ Executables = ${sbindir}]) AC_MSG_RESULT([ Man pages = ${mandir}]) AC_MSG_RESULT([ Libraries = ${libdir}]) AC_MSG_RESULT([ Header files = ${includedir}]) AC_MSG_RESULT([ Arch-independent files = ${datadir}]) AC_MSG_RESULT([ State information = ${localstatedir}]) AC_MSG_RESULT([ System configuration = ${sysconfdir}]) AC_MSG_RESULT([ AIS Plugins = ${LCRSODIR}]) AC_MSG_RESULT([]) AC_MSG_RESULT([ Use system LTDL = ${ac_cv_lib_ltdl_lt_dlopen}]) AC_MSG_RESULT([]) AC_MSG_RESULT([ HA group name = ${CRM_DAEMON_GROUP}]) AC_MSG_RESULT([ HA user name = ${CRM_DAEMON_USER}]) AC_MSG_RESULT([]) AC_MSG_RESULT([ CFLAGS = ${CFLAGS}]) AC_MSG_RESULT([ Libraries = ${LIBS}]) AC_MSG_RESULT([ Stack Libraries = ${CLUSTERLIBS}]) diff --git a/doc/Makefile.am b/doc/Makefile.am index e19c06393a..1960748bcf 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,166 +1,110 @@ # # doc: Pacemaker code # # Copyright (C) 2008 Andrew Beekhof # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License # as published by the Free Software Foundation; either version 2 # of the License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # MAINTAINERCLEANFILES = Makefile.in ascii = crm_cli.txt crm_fencing.txt -docbook = pacemaker-explained +docbook = Pacemaker_Explained man_MANS = cibadmin.8 crm_resource.8 doc_DATA = README.hb2openais index.html $(ascii) $(generated_docs) -chunked_docs = +publican_docs = generated_docs = XML_FILES := $(wildcard *.xml) PNG_FILES := $(wildcard images/*.png) -FOP_CONFIG = pacemaker-fop.xml - -# Paths to Norm Walsh's DocBook XSL stylesheets. -# Fetching these from the web on every run is probably dead slow, so -# make sure you have a local copy of these stylesheets installed, and -# XML catalogs set up correctly. On most systems, this is a simple -# matter of installing the docbook-xsl package. -#Web: STYLE_BASE ?= http://docbook.sourceforge.net/release/xsl/current -#OSX: STYLE_BASE=/opt/local/share/xsl/docbook-xsl -#F-12: STYLE_BASE=/usr/share/sgml/docbook/xsl-stylesheets -STYLE_BASE=http://docbook.sourceforge.net/release/xsl/current - -FO_STYLE ?= fo -HTML_STYLE ?= xhtml - -XSLT_DEFAULT=docbook.xsl -XSLT_PROFILE=profile-docbook.xsl -XSLT_CHUNKED=chunk.xsl -XSLT_CHUNKED_PROFILE=profile-chunk.xsl -TITLEPAGE_STYLE ?= $(STYLE_BASE)/template/titlepage.xsl - -# For HTML output, define the name of the frame where -# URLs should open -ULINK_TARGET ?= offsite-link -XSLTPROC_PROFILING_OPTIONS = - -PAPER_SIZE=A4 -#FO_BODY_FONT_FAMILY = --stringparam body.font.family "serif" -#FO_TITLE_FONT_FAMILY = --stringparam title.font.family "serif" - -#XSLTPROC_PROFILING_OPTIONS += --stringparam profile.arch $(ARCH) -#XSLTPROC_PROFILING_OPTIONS += --stringparam profile.condition $(CONDITION) -#XSLTPROC_PROFILING_OPTIONS += --stringparam profile.userlevel $(USERLEVEL) -#XSLTPROC_PROFILING_OPTIONS += --stringparam profile.vendor $(VENDOR) - -# For "status", use a slightly different logic. Unless set otherwise, -# always assume "current". -#STATUS ?= current -#XSLTPROC_PROFILING_OPTIONS += --stringparam profile.status $(STATUS) - -XSLT_OPT_HTML = --xinclude \ - $(XSLTPROC_PROFILING_OPTIONS) \ - --param use.id.as.filename 1 \ - --param generate.index 1 \ - --param admon.graphics 1 \ - --stringparam admon.graphics.path images/ \ - --stringparam admon.graphics.extension .png \ - --stringparam ulink.target $(ULINK_TARGET) \ - --stringparam html.stylesheet pacemaker.css \ - --stringparam toc.section.depth 2 \ - --stringparam chunk.first.sections 0 \ - --stringparam graphic.default.extension .png - -XSLT_OPT_FO ?= --xinclude \ - $(XSLTPROC_PROFILING_OPTIONS) \ - --stringparam paper.type $(PAPER_SIZE) \ - $(FO_BODY_FONT_FAMILY) \ - $(FO_TITLE_FONT_FAMILY) \ - --stringparam insert.link.page.number yes \ - --stringparam insert.xref.page.number yes \ - --stringparam graphic.default.extension png \ - --param section.autolabel 1 \ - --param section.autolabel.max.depth 2 \ - --param section.label.includes.component.label 1 \ - --stringparam generate.toc "/set toc,title /book toc,title /article toc.title" \ - --param use.extensions 1 \ - --param fop1.extensions 1 \ - --param tablecolumns.extension 0 \ - --param admon.graphics 1 \ - --stringparam admon.graphics.path images/ \ - --stringparam admon.graphics.extension .svg if BUILD_ASCIIDOC generated_docs += $(ascii:%.txt=%.html) endif if BUILD_DOCBOOK -generated_docs += $(docbook:%=%.html) -chunked_docs += $(docbook:%=%/index.html) +publican_docs += $(docbook) endif -if BUILD_FOP -generated_docs += $(docbook:%=%.pdf) -endif - -EXTRA_DIST = $(man_MANS) $(docbook:%=%.xml) pacemaker.css - -%.html: %.txt - $(ASCIIDOC) --unsafe --backend=xhtml11 $< - -%.html: %.xml - xsltproc -o $*.html $(XSLT_OPT_HTML) $(STYLE_BASE)/$(HTML_STYLE)/$(XSLT_DEFAULT) $< +EXTRA_DIST = $(man_MANS) $(docbook:%=%.xml) -%/index.html: %.xml images pacemaker.css - -rm -rf $* - -mkdir $* - cp -r $(srcdir)/pacemaker.css $(srcdir)/images $*/ - xsltproc -o $*/ $(XSLT_OPT_HTML) $(STYLE_BASE)/$(HTML_STYLE)/$(XSLT_CHUNKED) $< - -%.fo: %.xml $(PNG_FILES) - xsltproc -o $@ $(XSLT_OPT_FO) $(STYLE_BASE)/$(FO_STYLE)/$(XSLT_DEFAULT) $< - -%.pdf: %.fo - $(FOP) $< -pdf $@ -#fop -c $(FOP_CONFIG) $< -pdf $@ - -index.html: $(generated_docs) +index.html: echo "Building documentation index" echo "

The following Pacemaker documentation was generated on `date` from version: $(BUILD_VERSION)

" > index.html - echo "
    " >> index.html - for doc in $(generated_docs:%/index.html=%); do \ + echo "
      " >> index.html + for doc in $(generated_docs); do \ echo "
    1. $$doc
      2. " >> index.html; \ done + for book in $(docbook); do \ + for lang in `ls -1 $(docbook)/publish`; do \ + echo "
    2. $$book ($$lang)
        " >> index.html; \ + find $$book/publish/$$lang -name "*.pdf" -exec echo -n "
      • " \; -exec basename {} \; -exec echo "
        • " \; | sed s:$$book/publish/:: >> index.html ; \ + find $$book/publish/$$lang -name "*.txt" -exec echo -n "
      • " \; -exec basename {} \; -exec echo "
        • " \; | sed s:$$book/publish/:: >> index.html ; \ + find $$book/publish/$$lang -name html -exec echo "
      • $$book HTML
        • " \; | sed s:$$book/publish/:: >> index.html ; \ + find $$book/publish/$$lang -name html-single -exec echo "
      • $$book HTML (single page)
        • " \; | sed s:$$book/publish/:: >> index.html ; \ + echo "
      3. " >> index.html; \ + done; \ + done echo "
    " >> index.html echo "

    You can find additional documentation and details about the Pacemaker project at http://www.clusterlabs.org

    " >> index.html echo "" >> index.html -all-local: $(chunked_docs) -install-data-local: all-local +%.html: %.txt + $(ASCIIDOC) --unsafe --backend=xhtml11 $< + +#all-local: $(chunked_docs) + +docbook_txt = $(docbook:%=%.txt) + +%.txt: %/en-US/*.xml +if BUILD_DOCBOOK + cd $* && $(PUBLICAN) build --publish --langs=all --formats=pdf,html,html-single,txt + cp $*/publish/en-US/Pacemaker/1.0/txt/$*/$@ $@ +else + touch $@ +endif + +all-local: $(docbook_txt) + +#install-data-local: all-local +install-data-local: all-local if BUILD_DOCBOOK for book in $(docbook); do \ - $(INSTALL) -d 755 $(DESTDIR)/$(docdir)/$$book/images; \ - $(INSTALL) -m 644 $$book/*.* $(DESTDIR)/$(docdir)/$$book; \ - $(INSTALL) -m 644 $$book/images/*.* $(DESTDIR)/$(docdir)/$$book/images; \ + filelist=`find $$book/publish -print`; \ + for f in $$filelist; do \ + p=`echo $$f | sed s:publish/:: | sed s:Pacemaker/::`; \ + if [ -d $$f ]; then \ + echo $(INSTALL) -d 775 $(DESTDIR)/$(docdir)/$$p; \ + else \ + echo $(INSTALL) -m 644 $$f $(DESTDIR)/$(docdir)/$$p; \ + fi \ + done; \ done endif -push: index.html $(generated_docs:%/index.html=%) images pacemaker.css +push: all-local index.html echo Uploading current documentation set to clusterlabs.org - scp -r $^ root@oss.clusterlabs.org:/srv/www/extras/doc/ + rsync -rtz --progress index.html root@oss.clusterlabs.org:/srv/www/extras/doc/ +if BUILD_DOCBOOK + for book in $(docbook); do \ + echo Uploading $$book...; \ + rsync -rtz --progress --delete $$book/publish/* root@oss.clusterlabs.org:/srv/www/extras/doc/; \ + done +endif clean-local: - -rm -rf $(generated_docs) $(docbook) $(docbook:%=%.fo) + -rm -rf $(generated_docs) $(docbook)/tmp $(docbook)/publish diff --git a/doc/Pacemaker_Explained/en-US/Ap-Changes.xml b/doc/Pacemaker_Explained/en-US/Ap-Changes.xml new file mode 100644 index 0000000000..73d5c56005 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-Changes.xml @@ -0,0 +1,86 @@ + + What Changed in 1.0 +
    + New + + Failure timeouts. See + New section for resource and operation defaults. See and + Tool for making offline configuration changes. See + Rules, instance_attributes, meta_attributes and sets of operations can be defined once and referenced in multiple places. See + The CIB now accepts XPath-based create/modify/delete operations. See the cibadmin help text. + Multi-dimensional colocation and ordering constraints. See and + The ability to connect to the CIB from non-cluster machines. See + Allow recurring actions to be triggered at known times. See + +
    +
    + Changed + + + Syntax + + All resource and cluster options now use dashes (-) instead of underscores (_) + master_slave was renamed to master + The attributes container tag was removed + The operation field pre-req has been renamed requires + All operations must have an interval, start/stop must have it set to zero + + + The stonith-enabled option now defaults to true. + The cluster will refuse to start resources if stonith-enabled is true (or unset) and no STONITH resources have been defined + The attributes of colocation and ordering constraints were renamed for clarity. See and + resource-failure-stickiness has been replaced by migration-threshold. See + The arguments for command-line tools has been made consistent + + Switched to RelaxNG schema validation and libxml2 parser. + + + id fields are now XML IDs which have the following limitations + + id's cannot contain colons (:) + id's cannot begin with a number + id's must be globally unique (not just unique for that tag) + + + + + Some fields (such as those in constraints that refer to resources) are IDREFs. + This means that they must reference existing resources or objects in order for the configuration to be valid. + Removing an object which is referenced elsewhere will therefor fail. + + + + + The CIB representation from which the MD5 digest used to verify CIBs has changed. + This means that every CIB update will require a full refresh on any upgraded nodes until the cluster is fully upgraded to 1.0. + This will result in significant performance degradation and it is therefor highly inadvisable to run a mixed 1.0/0.6 cluster for any longer than absolutely necessary. + + + + + + Ping node information no longer needs to be added to ha.cf Simply include the lists of hosts in your ping resource(s). + + +
    +
    + Removed + + + Syntax + + + + It is no longer possible to set resource meta options as top-level attributes. Use meta attributes instead. + + + + + Resource and operation defaults are no longer read from crm_config. See and instead. + + + + + +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ap-Debug.xml b/doc/Pacemaker_Explained/en-US/Ap-Debug.xml new file mode 100644 index 0000000000..bfe3f171e6 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-Debug.xml @@ -0,0 +1,128 @@ + + Debugging Cluster Startup +
    + OpenAIS + +
    + Prerequisites + + Minimum logging configuration + + + # /etc/init.d/openais start + + + logging { + to_syslog: yes + syslog_facility: daemon + } + + + + Whatever other logging you have, these two lines are required for Pacemaker clusters + + +
    +
    + Confirm OpenAIS Started +
    + Expected output when starting openais + + + # /etc/init.d/openais start + + + Starting OpenAIS daemon (aisexec): starting... rc=0: OK + + +
    + +
    + Expected log messages - startup + + + # grep -e "openais.*network interface" -e "AIS Executive Service" /var/log/messages + + + Aug 27 16:23:37 test1 openais[26337]: [MAIN ] AIS Executive Service RELEASE 'subrev 1152 version 0.80' + Aug 27 16:23:38 test1 openais[26337]: [MAIN ] AIS Executive Service: started and ready to provide service. + Aug 27 16:23:38 test1 openais[26337]: [TOTEM] The network interface [192.168.9.41] is now up. + + + + The versions may differ, but you should see OpenAIS indicate it started and sucessfully attached to the machine's network interface + +
    + +
    + Expected log messages - membership + + + # grep CLM /var/log/messages + + + Aug 27 16:53:15 test1 openais[2166]: [CLM ] CLM CONFIGURATION CHANGE + Aug 27 16:53:15 test1 openais[2166]: [CLM ] New Configuration: + Aug 27 16:53:15 test1 openais[2166]: [CLM ] Members Left: + Aug 27 16:53:15 test1 openais[2166]: [CLM ] Members Joined: + Aug 27 16:53:15 test1 openais[2166]: [CLM ] CLM CONFIGURATION CHANGE + Aug 27 16:53:15 test1 openais[2166]: [CLM ] New Configuration: + Aug 27 16:53:15 test1 openais[2166]: [CLM ] r(0) ip(192.168.9.41) + Aug 27 16:53:15 test1 openais[2166]: [CLM ] Members Left: + Aug 27 16:53:15 test1 openais[2166]: [CLM ] Members Joined: + Aug 27 16:53:15 test1 openais[2166]: [CLM ] r(0) ip(192.168.9.41) + Aug 27 16:53:15 test1 openais[2166]: [CLM ] got nodejoin message 192.168.9.41 + + + + The exact messages will differ, but you should see a new membership formed with the real IP address of your node + +
    +
    + +
    + Checking Pacemaker + Now that we have confirmed that OpenAIS is functional we can check the rest of the stack. + +
    + Expected Pacemaker startup logging for OpenAIS + + + # grep pcmk_plugin_init /var/log/messages + + + Aug 27 16:53:15 test1 openais[2166]: [pcmk ] info: pcmk_plugin_init: CRM: Initialized + Aug 27 16:53:15 test1 openais[2166]: [pcmk ] Logging: Initialized pcmk_plugin_init + Aug 27 16:53:15 test1 openais[2166]: [pcmk ] info: pcmk_plugin_init: Service: 9 + Aug 27 16:53:15 test1 openais[2166]: [pcmk ] info: pcmk_plugin_init: Local hostname: test1 + + + + If you don't see these messages, or some like them, there is likely a problem finding or loading the pacemaker plugin. + +
    + +
    + Expected process listing on a 64-bit machine + + + # ps axf + + + 3718 ? Ssl 0:05 /usr/sbin/aisexec + 3723 ? SLs 0:00 \_ /usr/lib64/heartbeat/stonithd + 3724 ? S 0:05 \_ /usr/lib64/heartbeat/cib + 3725 ? S 0:21 \_ /usr/lib64/heartbeat/lrmd + 3726 ? S 0:01 \_ /usr/lib64/heartbeat/attrd + 3727 ? S 0:00 \_ /usr/lib64/heartbeat/pengine + 3728 ? S 0:01 \_ /usr/lib64/heartbeat/crmd + + + + On 32-bit systems the exact path may differ, but all the above processes should be listed. + +
    + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ap-FAQ.xml b/doc/Pacemaker_Explained/en-US/Ap-FAQ.xml new file mode 100644 index 0000000000..e7c095c75e --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-FAQ.xml @@ -0,0 +1,96 @@ + + FAQ + + + History + + + Why is the Project Called Pacemaker? + + + First of all, the reason its not called the CRM is because of the abundance of terms that are commonly abbreviated to those three letters. + + The Pacemaker name came from Kham, a good friend of mine, and was originally used by a Java GUI that I was prototyping in early 2007. + Alas other commitments have prevented the GUI from progressing much and, when it came time to choose a name for this project, Lars suggested it was an even better fit for an independent CRM. + + + The idea stems from the analogy between the role of this software and that of the little device that keeps the human heart pumping. + Pacemaker monitors the cluster and intervenes when necessary to ensure the smooth operation of the services it provides. + + There were a number of other names (and acronyms) tossed around, but suffice to say "Pacemaker" was the best + + + + + Why was the Pacemaker Project Created? + + + The decision was made to spin-off the CRM into its own project after the 2.1.3 Heartbeat release in order to + + support both the OpenAIS and Heartbeat cluster stacks equally + decouple the release cycles of two projects at very different stages of their life-cycles + foster the clearer package boundaries, thus leading to + better and more stable interfaces + + + + + + Setup + + + What Messaging Layers are Supported? + + + + OpenAIS () + Heartbeat () + + + + + + Can I Choose which Messaging Layer to use at Run Time? + + + Yes. The CRM will automatically detect who started it and behave accordingly. + + + + + Can I Have a Mixed Heartbeat-OpenAIS Cluster? + + + No. + + + + + Which Messaging Layer Should I Choose? + + + This is discussed in . + + + + + Where Can I Get Pre-built Packages? + + + Official packages for most major .rpm and .deb based distributions are available from: + + For more information, see our installation page. + + + + + What Versions of Pacemaker Are Supported? + + + Please refer to the Releases page for an up-to-date list of versions supported directly by the project. + When seeking assistance, please try to ensure you have one of these versions. + + + + + diff --git a/doc/Pacemaker_Explained/en-US/Ap-Install.xml b/doc/Pacemaker_Explained/en-US/Ap-Install.xml new file mode 100644 index 0000000000..23696c04f7 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-Install.xml @@ -0,0 +1,108 @@ + + Installation +
    + Choosing a Cluster Stack + Ultimately the choice of cluster stack is a personal decision that must be made in the context of you or your company's needs and strategic direction. Pacemaker currently functions equally well with both stacks. + Here are some factors that may influence the decision + + + SUSE/Novell, Red Hat and Oracle are all putting their collective weight behind the OpenAIS cluster stack. + + + OpenAIS is an OSI Certified implementation of an industry standard (the Service Availability Forum Application Interface Specification). + + + Using OpenAIS gives your applications access to the following additional cluster services + + + checkpoint service + + + distributed locking service + + + extended virtual synchrony service + + + cluster closed process group service + + + + + It is likely that Pacemaker, at some point in the future, will make use of some of these additional services not provided by Heartbeat + + + To date, Pacemaker has received less real-world testing on OpenAIS than it has on Heartbeat. + + +
    +
    + Enabling Pacemaker +
    + For OpenAIS + The OpenAIS configuration is normally located in /etc/ais/openais.conf and an example for a machine with an address of 1.2.3.4 in a cluster communicating on port 1234 (without peer authentication and message encryption) is shown below. + + An example OpenAIS configuration file + + totem { + version: 2 + secauth: off + threads: 0 + interface { + ringnumber: 0 + bindnetaddr: 1.2.3.4 + mcastaddr: 226.94.1.1 + mcastport: 1234 + } + } + logging { + fileline: off + to_syslog: yes + syslog_facility: daemon + } + amf { + mode: disabled + } + + + The logging should be mostly obvious and the amf section refers to the Availability Management Framework and is not covered in this document. + The interesting part of the configuration is the totem section. This is where we define the how the node can communicate with the rest of the cluster and what protocol version and options (including encryption + Please consult the OpenAIS website and documentation for details on enabling encryption and peer authentication for the cluster. + ) it should use. Beginners are encouraged to use the values shown and modify the interface section based on their network. + It is also possible to configure OpenAIS for an IPv6 based environment. Simply configure bindnetaddr and mcastaddr with their IPv6 equivalents. Eg + + Example options for an IPv6 environment + + bindnetaddr: fec0::1:a800:4ff:fe00:20 + mcastaddr: ff05::1 + + + To tell OpenAIS to use the Pacemaker cluster manager, add the following fragment to a functional OpenAIS configuration and restart the cluster. + + Configuration fragment for enabling Pacemaker under OpenAIS + + aisexec { + user: root + group: root + } + service { + name: pacemaker + ver: 0 + } + + + The cluster needs to be run as root so that its child processes (the lrmd in particular) have sufficient privileges to perform the actions requested of it. After-all, a cluster manager that can't add an IP address or start apache is of little use. + The second directive is the one that actually instructs the cluster to run Pacemaker. +
    +
    + For Heartbeat + Add the following to a functional ha.cf configuration file and restart Heartbeat + + Configuration fragment for enabling Pacemaker under Heartbeat + + crm respawn + + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ap-LSB.xml b/doc/Pacemaker_Explained/en-US/Ap-LSB.xml new file mode 100644 index 0000000000..6ac60d7bf9 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-LSB.xml @@ -0,0 +1,60 @@ + + Is This init Script LSB Compatible? + Assuming some_service is configured correctly and currently not active, the following sequence will help you determine if it is LSB compatible: + + + Start (stopped): + /etc/init.d/some_service start ; echo "result: $?" + + Did the service start? + Did the command print result: 0 (in addition to the regular output)? + + + para>Status (running): + /etc/init.d/some_service status ; echo "result: $?" + + Did the script accept the command? + Did the script indicate the service was running? + Did the command print result: 0 (in addition to the regular output)? + + + para>Start (running): + /etc/init.d/some_service start ; echo "result: $?" + + Is the service still running? + Did the command print result: 0 (in addition to the regular output)? + + + para>Stop (running): + /etc/init.d/some_service stop ; echo "result: $?" + + Was the service stopped? + Did the command print result: 0 (in addition to the regular output)? + + + para>Status (stopped): + /etc/init.d/some_service status ; echo "result: $?" + + Did the script accept the command? + Did the script indicate the service was not running? + Did the command print result: 3 (in addition to the regular output)? + + + + Stop (stopped): + /etc/init.d/some_service stop ; echo "result: $?" + + Is the service still stopped? + Did the command print result: 0 (in addition to the regular output)? + + + + Status (failed): + This step is not readily testable and relies on manual inspection of the script. + The script can use one of the error codes (other than 3) listed in the LSB spec to indicate that it is active but failed. + This tells the cluster that before moving the resource to another node, it needs to stop it on the existing one first. + + + The script can use one of the error codes (other than 3) listed in the LSB spec to indicate that it is active but failed. This tells the cluster that before moving the resource to another node, it needs to stop it on the existing one first. + If the answer to any of the above questions is no, then the script is not LSB compliant. Your options are then to either fix the script or write an OCF agent based on the existing script. + diff --git a/doc/Pacemaker_Explained/en-US/Ap-OCF.xml b/doc/Pacemaker_Explained/en-US/Ap-OCF.xml new file mode 100644 index 0000000000..79a5bd4e91 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-OCF.xml @@ -0,0 +1,209 @@ + + More About OCF Resource Agents +
    + Location of Custom Scripts + OCF Resource Agents are found in /usr/lib/ocf/resource.d/{provider}. + + When creating your own agents, you are encouraged to create a new directory under /usr/lib/ocf/resource.d/ so that they are not confused with (or overwritten by) the agents shipped with Heartbeat. + So, for example, if you chose the provider name of bigCorp and wanted a new resource named bigApp, you would create a script called /usr/lib/ocf/resource.d/bigCorp/bigApp and define a resource: + + <primitive id="custom-app" class="ocf" provider="bigCorp" type="bigApp"/> +
    +
    + Actions + All OCF Resource Agents are required to implement the following actions + + Required Actions for OCF Agents + + + + Action + Description + Instructions + + + + + start + Start the resource + Return 0 on success and an appropriate error code otherwise. Must not report success until the resource is fully active. + + + stop + Stop the resource + Return 0 on success and an appropriate error code otherwise. Must not report success until the resource is fully stopped. + + + monitor + Check the resource's state + + Exit 0 if the resource is running, 7 if it is stopped and anything else if it is failed. + NOTE: The monitor script should test the state of the resource on the local machine only. + + + + meta-data + Describe the resource + + Provide information about this resource as an XML snippet. Exit with 0. + NOTE: This is not performed as root. + + + + validate-all + Verify the supplied parameters are correct + Exit with 0 if parameters are valid, 2 if not valid, 6 if resource is not configured. + +
    + Additional requirements (not part of the OCF specs) are placed on agents that will be used for advanced concepts like clones and multi-state resources. + + Optional Actions for OCF Agents + + + + Action + Description + Instructions + + + promote + Promote the local instance of a multi-state resource to the master/primary state + Return 0 on success + + + demote + Demote the local instance of a multi-state resource to the slave/secondary state + Return 0 on success + + + notify + Used by the cluster to send the agent pre and post notification events telling the resource what is or did just take place + Must not fail. Must exit 0 + +
    + Some actions specified in the OCF specs are not currently used by the cluster + + reload - reload the configuration of the resource instance without disrupting the service + recover - a variant of the start action, this should try to recover a resource locally. + + + Remember to use ocf-tester to verify that your new agent complies with the OCF standard properly. +
    +
    + How Does the Cluster Interpret the OCF Return Codes? + The first thing the cluster does is check the return code against the expected result. +If the result does not match the expected value, then the operation is considered to have failed and recovery action is initiated. + + There are three types of failure recovery: + + Types of recovery performed by the cluster + + + + Recovery Type + Description + Action Taken by the Cluster + + + soft + A transient error occurred + Restart the resource or move it to a new location + + + hard + A non-transient error that may be specific to the current node occurred + Move the resource elsewhere and prevent it from being retried on the current node + + + fatal + A non-transient error that will be common to all cluster nodes (I.e. a bad configuration was specified) + Stop the resource and prevent it from being started on any cluster node + +
    + Assuming an action is considered to have failed, the following table outlines the different OCF return codes and the type of recovery the cluster will initiate when it is received. + + OCF Return Codes and How They are Handled + + + + OCF Return Code + OCF Alias + Description + Recovery Type + + + 0 + OCF_SUCCESS + Success. The command complete successfully. This is the expected result for all start, stop, promote and demote commands. + soft + + + 1 + OCF_ERR_GENERIC + Generic "there was a problem" error code. + soft + + + 2 + OCF_ERR_ARGS + The resource's configuration is not valid on this machine. Eg. Refers to a location/tool not found on the node. + hard + + + 3 + OCF_ERR_UNIMPLEMENTED + The requested action is not implemented. + hard + + + 4 + OCF_ERR_PERM + The resource agent does not have sufficient privileges to complete the task. + hard + + + 5 + OCF_ERR_INSTALLED + The tools required by the resource are not installed on this machine. + hard + + + 6 + OCF_ERR_CONFIGURED + The resource's configuration is invalid. Eg. A required parameters are missing. + fatal + + + 7 + OCF_NOT_RUNNING + The resource is safely stopped. The cluster will not attempt to stop a resource that returns this for any action. + N/A + + + 8 + OCF_RUNNING_MASTER + The resource is running in Master mode. + soft + + + 9 + OCF_FAILED_MASTER + The resource is in Master mode but has failed. The resource will be demoted, stopped and then started (and possibly promoted) again. + soft + + + other + NA + Custom error code. + soft + +
    + Although counter intuitive, even actions that return 0 (aka. OCF_SUCCESS) can be considered to have failed. +This can happen when a resource that is expected to be in the Master state is found running as a Slave, or when a resource is found active on multiple machines..
    Exceptions + + Non-recurring monitor actions (probes) that find a resource active (or in Master mode) will not result in recovery action unless it is also found active elsewhere + The recovery action taken when a resource is found active more than once is determined by the multiple-active property of the resource + Recurring actions that return OCF_ERR_UNIMPLEMENTED do not cause any type of recovery + +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ap-Samples.xml b/doc/Pacemaker_Explained/en-US/Ap-Samples.xml new file mode 100644 index 0000000000..6054cdb44e --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-Samples.xml @@ -0,0 +1,137 @@ + Sample Configurations +
    + An Empty Configuration + + An empty configuration + + + + + + + + + + +]]> + + +
    +
    + A Simple Configuration + + 2 nodes, some cluster options and a resource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> + + + In this example, we have one resource (an IP address) that we check every five minutes and will run on host c001n01 until either the resource fails 10 times or the host shuts down. +
    +
    + An Advanced Configuration + + + groups and clones with stonith + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> + + +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ap-Upgrade-Config.xml b/doc/Pacemaker_Explained/en-US/Ap-Upgrade-Config.xml new file mode 100644 index 0000000000..8a7ff366d7 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-Upgrade-Config.xml @@ -0,0 +1,93 @@ + + Upgrading the Configuration from 0.6 +
    + Preparation + Download the latest DTD from and ensure your configuration validates. +
    +
    + Perform the upgrade +
    + Upgrade the software + Refer to the appendix: +
    +
    + Upgrade the Configuration + As XML is not the friendliest of languages, it is common for cluster administrators to have scripted some of their activities. In such cases, it is likely that those scripts will not work with the new 1.0 syntax. + In order to support such environments, it is actually possible to continue using the old 0.6 syntax. + The downside however, is that not all the new features will be available and there is a performance impact since the cluster must do a non-persistent configuration upgrade before each transition. So while using the old syntax is possible, it is not advisable to continue using it indefinitely. + Even if you wish to continue using the old syntax, it is advisable to follow the upgrade procedure to ensure that the cluster is able to use your existing configuration (since it will perform much the same task internally). + + + Create a shadow copy to work with + crm_shadow --create upgrade06 + + + Verify the configuration is valid + crm_verify --live-check + + + Fix any errors or warnings + + + Perform the upgrade + cibadmin --upgrade + If this step fails, there are three main possibilities + + The configuration was not valid to start with - go back to step 2 + The transformation failed - report a bug or email the project at pacemaker@oss.clusterlabs.org + The transformation was successful but produced an invalid result + + The most common reason is ID values being repeated or invalid. Pacemaker 1.0 is much stricter regarding this type of validation + + + + If the result of the transformation is invalid, you may see a number of errors from the validation library. If these are not helpful, visit and/or try the following procedure described below under . + + + Check the changes + crm_shadow --diff + If at this point there is anything about the upgrade that you wish to fine-tune (for example, to change some of the automatic IDs) now is the time to do so. Since the shadow configuration is not in use by the cluster, it is safe to edit the file manually: + crm_shadow --edit + Will open the configuration in your favorite editor (or whichever one is specified by the standard EDITOR environment variable). + + + Preview how the cluster will react + Test what the cluster will do when you upload the new configuration + ptest -VVVVV --live-check --save-dotfile upgrade06.dot + graphviz upgrade06.dot + + Verify that either no resource actions will occur or that you are happy with any that are scheduled. + If the output contains actions you do not expect (possibly due to changes to the score calculations), you may need to make further manual changes. + See for further details on how to interpret the output of ptest. + + + + Upload the changes + crm_shadow --commit upgrade06 --force + If this step fails, something really strange has occurred. You should report a bug. + + +
    +
    + Manually Upgrading the Configuration + It is also possible to perform the configuration upgrade steps manually. To do this + + + Locate the upgrade06.xsl conversion script or download the latest version from version control + + + + xsltproc /path/tp/upgrade06.xsl config06.xml > config10.xml + + + Locate the pacemaker.rng script. + + + xmllint --relaxng /path/tp/pacemaker.rng config10.xml + + + + The advantage of this method is that it can be performed without the cluster running and any validation errors should be more informative (despite being generated by the same library!) since they include line numbers. +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ap-Upgrade.xml b/doc/Pacemaker_Explained/en-US/Ap-Upgrade.xml new file mode 100644 index 0000000000..2357fcb393 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ap-Upgrade.xml @@ -0,0 +1,238 @@ + + Upgrading Cluster Software +
    + Version Compatibility + When releasing newer versions we take care to make sure we are backwardly compatible with older versions. While you will always be able to upgrade from version x to x+1, in order to continue to produce high quality software it may occasionally be necessary to drop compatibility with older versions. + There will always be an upgrade path from any series-2 release to any other series-2 release. + There are three approaches to upgrading your cluster software + + Complete Cluster Shutdown + Rolling (node by node) + Disconnect and Reattach + + Each method has advantages and disadvantages, some of which are listed in the table below, and you should chose the one most appropriate to your needs. + + Summary of Upgrade Methodologies + + + + Type + Available between all software versions + Service Outage During Upgrade + Service Recovery During Upgrade + Exercises Failover Logic/Configuration + + Allows change of cluster stack type + + + For example, switching from Heartbeat to OpenAIS. + Consult the Heartbeat or OpenAIS documentation to see if upgrading them to a newer version is also supported + + + + + + + + Shutdown + yes + always + N/A + no + yes + + + Rolling + no + always + yes + yes + no + + + Reattach + yes + only due to failure + no + no + yes + + + +
    +
    +
    + Complete Cluster Shutdown + In this scenario one shuts down all cluster nodes and resources and upgrades all the nodes before restarting the cluster. +
    Procedure + + + On each node: + + + Shutdown the cluster stack (Heartbeat or OpenAIS) + + + + Upgrade the Pacemaker software. + This may also include upgrading the cluster stack and/or the underlying operating system.. + + + + + + Check the configuration manually or with the crm_verify tool if available. + + + On each node: + + + + Start the cluster stack. + This can be either OpenAIS or Heartbeat and does not need to be the same as the previous cluster stack. + + + + + +
    +
    +
    + Rolling (node by node) + In this scenario each node is removed from the cluster, upgraded and then brought back online until all nodes are running the newest version. +
    + Procedure + On each node: + + + Shutdown the cluster stack (Heartbeat or OpenAIS) + + + Upgrade the Pacemaker software. This may also include upgrading the cluster stack and/or the underlying operating system. + + + On the first node, check the configuration manually or with the crm_verify tool if available. + + + + + + Start the cluster stack. + This must be the same type of cluster stack (OpenAIS or Heartbeat) that the rest of the cluster is using. + Upgrading OpenAIS/Heartbeat may also be possible, please consult the documentation for those projects to see if the two versions will be compatible. + + + + Repeat for each node in the cluster +
    +
    + Version Compatibility + + Version Compatibility Table + + + + Version being Installed + Oldest Compatible Version + + + Pacemaker 1.0 + Pacemaker 0.6 or Heartbeat 2.1.3 + + + Pacemaker 0.7 + Pacemaker 0.6 or Heartbeat 2.1.3 + + + Pacemaker 0.6 + Heartbeat 2.0.8 + + + Heartbeat 2.1.3 (or less) + Heartbeat 2.0.4 + + + Heartbeat 2.0.4 (or less) + Heartbeat 2.0.0 + + + Heartbeat 2.0.0 + None. Use an alternate upgrade strategy. + +
    +
    +
    + Crossing Compatibility Boundaries + Rolling upgrades that cross compatibility boundaries must be preformed in multiple steps. For example, to perform a rolling update from Heartbeat 2.0.1 to Pacemaker 1.0.0 one must: + + Perform a rolling upgrade from Heartbeat 2.0.1 to Heartbeat 2.0.4 + Perform a rolling upgrade from Heartbeat 2.0.4 to Heartbeat 2.1.3 + Perform a rolling upgrade from Heartbeat 2.1.3 to Pacemaker 1.0.0 + +
    +
    +
    + Disconnect and Reattach + A variant of a complete cluster shutdown, but the resources are left active and re-detected when the cluster is restarted. +
    + Procedure + + + + Tell the cluster to stop managing services. + This is required to allow the services to remain active after the cluster shuts down. + + crm_attribute -t crm_config -n is-managed-default -v false + + + For any resource that has a value for is-managed, make sure it is set to false (so that the cluster will not stop it) + crm_resource -t primitive -r <rsc_id> -p is-managed -v false + + + On each node: + + + Shutdown the cluster stack (Heartbeat or OpenAIS) + + + Upgrade the cluster stack program - This may also include upgrading the underlying operating system. + + + + + Check the configuration manually or with the crm_verify tool if available. + + + On each node: + + + Start the cluster stack. + This can be either OpenAIS or Heartbeat and does not need to be the same as the previous cluster stack. + + + + + Verify the cluster re-detected all resources correctly + + + Allow the cluster to resume managing resources again + crm_attribute -t crm_config -n is-managed-default -v true + + + For any resource that has a value for is-managed reset it to true (so the cluster can recover the service if it fails) if desired + crm_resource -t primitive -r <rsc_id> -p is-managed -v false + + +
    +
    + Notes + + Always check your existing configuration is still compatible with the version you are installing before starting the cluster. + + + + The oldest version of the CRM to support this upgrade type was in Heartbeat 2.0.4 + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Author_Group.xml b/doc/Pacemaker_Explained/en-US/Author_Group.xml new file mode 100644 index 0000000000..52ff3e1a50 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Author_Group.xml @@ -0,0 +1,10 @@ + + + + + AndrewBeekhof + Red Hat + andrew@beekhof.net + + diff --git a/doc/Pacemaker_Explained/en-US/Book_Info.xml b/doc/Pacemaker_Explained/en-US/Book_Info.xml new file mode 100644 index 0000000000..d84de6f1d4 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Book_Info.xml @@ -0,0 +1,40 @@ + + + + Configuration Explained + An A-Z guide to Pacemaker's Configuration Options + Pacemaker + 1.0 + 1 + 0 + + + The purpose of this document is to definitively explain the concepts used to configure Pacemaker. + To achieve this best, it will focus exclusively on the XML syntax used to configure the CIB. + + + For those that are allergic to XML, Pacemaker comes with a cluster shell and a Python based GUI exists, however these tools will not be covered at all in this document + + It is hoped however, that having understood the concepts explained here, that the functionality of these tools will also be more readily understood. + + , precisely because they hide the XML. + + + Additionally, this document is NOT a step-by-step how-to guide for configuring a specific clustering scenario. + Although such guides exist, the purpose of this document is to provide an understanding of the building blocks that can be used to construct any type of Pacemaker cluster. + + + + + + + + + + + + + + + diff --git a/doc/Pacemaker_Explained/en-US/Ch-Advanced-Options.xml b/doc/Pacemaker_Explained/en-US/Ch-Advanced-Options.xml new file mode 100644 index 0000000000..68305df089 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Advanced-Options.xml @@ -0,0 +1,449 @@ + Advanced Configuration +
    + Connecting to the Cluster Configuration from a Remote Machine + + Provided Pacemaker is installed on a machine, it is possible to connect to the cluster even if the machine itself is not a part of it. + To do this, one simply sets up a number of environment variables and runs the same commands as you would when working on a cluster node. + + + Environment Variables Used to Connect to Remote Instances of the CIB + + + + Environment Variable + Description + + + CIB_user + The user to connect as. Needs to be part of the hacluster group on the target host. Defaults to $USER + + + + CIB_password + The user's password. Read from the command line if unset + + + CIB_server + The host to contact. Defaults to localhost. + + + CIB_port + The port on which to contact the server. Required. + + + CIB_encrypted + Encrypt network traffic. Defaults to true. + + + +
    + + So if c001n01 is an active cluster node and is listening on 1234 for connections, and someguy is a member of the hacluster group. + Then the following would prompt for someguy's password and return the cluster's current configuration: + + + + export CIB_port=1234; export CIB_server=c001n01; export CIB_user=someguy; + cibadmin -Q + + + + For security reasons, the cluster does not listen remote connections by default. + If you wish to allow remote access, you need to set the remote-tls-port (encrypted) or remote-clear-port (unencrypted) top-level options (ie. those kept in the cib tag , like num_updates and epoch). + + + Extra top-level CIB options for remote access + + + + Field + Description + + + remote-tls-port + Listen for encrypted remote connections on this port. Default: none + + + remote-clear-port + Listen for plaintext remote connections on this port. Default: none + + + +
    +
    +
    + Specifying When Recurring Actions are Performed + + By default, recurring actions are scheduled relative to when the resource started. + So if your resource was last started at 14:32 and you have a backup set to be performed every 24 hours, then the backup will always run at in the middle of the business day - hardly desirable. + + + To specify a date/time that the operation should be relative to, set the operation's interval-origin. + The cluster uses this point to calculate the correct start-delay such that the operation will occur at origin + (interval * N). + + + So if the operation's interval is 24h, it's interval-origin is set to 02:00 and it is currently 14:32, then the cluster would initiate the operation with a start delay of 11 hours and 28 minutes. + If the resource is moved to another node before 2am, then the operation is of course cancelled. + + + The value specified for interval and interval-origin can be any date/time conforming to the ISO8601 standard. + By way of example, to specify an operation that would run on the first Monday of 2009 and every Monday after that you would add: + + + Specifying a Base for Recurring Action Intervals + + <op id="my-weekly-action" name="custom-action" interval="P7D" interval-origin="2009-W01-1"/> + + +
    +
    + Moving Resources +
    + Manual Intervention + There are primarily two occasions when you would want to move a resource from it's current location: when the whole node is under maintenance and when a single resource needs to be moved. + + In the case where everything needs to move, since everything eventually comes down to a score, you could create constraints for every resource you have preventing it from running on that node. + While the configuration can seem convoluted at times, not even we would require this of administrators. + + + Instead one can set a special node attribute which tells the cluster "don't let anything run here". + There is even a helpful tool to help query and set it called crm_standby. + To check the standby status of the current machine, simply run: + + crm_standby --get-value + + A value of true indicates that the node is NOT able to host any resources and a value of false indicates that it CAN. + You can also check the status of other nodes in the cluster by specifying the --node-uname option. Eg. + + crm_standby --get-value --node-uname sles-2 + To change the current node's standby status, use --attr-value instead of --get-value. Eg. + crm_standby --attr-value + Again, you can change another host's value by supplying a host name with --node-uname. + + When only one resource is required to move, we do this by creating location constraints. + However once again we provide a user friendly shortcut as part of the crm_resource command which creates and modifies the extra constraints for you. + If Email was running on sles-1 and you wanted it moved to a specific location, the command would look something like: + + crm_resource -M -r Email -H sles-2 + Behind the scenes, the tool will create the following location constraint: + + + <rsc_location rsc="Email" node="sles-2" score="INFINITY"/> + + + It is important to note that subsequent invocations of crm_resource -M are not cumulative. So if you ran: + crm_resource -M -r Email -H sles-2 + crm_resource -M -r Email -H sles-3 + then it is as if you had never performed the first command. + To allow the resource to move back again, use: + crm_resource -U -r Email + + Note the use of the word allow. + The resource can move back to its original location but, depending on resource stickiness, it may stay where it is. + To be absolutely certain that it moves back to sles-1, move it there before issuing the call to crm_resource -U: + + crm_resource -M -r Email -H sles-1 + crm_resource -U -r Email + Alternatively, if you only care that the resource should be moved from its current location, try + crm_resource -M -r Email + Which will instead create a negative constraint. Eg. + <rsc_location rsc="Email" node="sles-1" score="-INFINITY"/> + + This will achieve the desired effect but will also have long-term consequences. + As the tool will warn you, the creation of a -INFINITY constraint will prevent the resource from running on that node until crm_resource -U is used. + This includes the situation where every other cluster node is no longer available. + + + In some cases, such as when resource stickiness is set to INFINITY, it is possible that you will end up with the problem described in . + The tool can detect some of these cases and deals with them by also creating both a positive and negative constraint. Eg. + + Email prefers sles-1 with a score of -INFINITY + Email prefers sles-2 with a score of INFINITY + which has the same long-term consequences as discussed earlier. +
    +
    + Moving Resources Due to Failure + New in 1.0 is the concept of a migration threshold + + + The naming of this option was unfortunate as it is easily confused with true migration, the process of moving a resource from one node to another without stopping it. + Xen virtual guests are the most common example of resources that can be migrated in this manner. + + . + Simply define migration-threshold=N for a resource and it will migrate to a new node after N failures. + There is no threshold defined by default. + To determine the resource's current failure status and limits, use crm_mon --failcounts + + + By default, once the threshold has been reached, node will no longer be allowed to run the failed resource until the administrator manually resets the resource's failcount using crm_failcount (after hopefully first fixing the failure's cause). + However it is possible to expire them by setting the resource's failure-timeout option. + + So a setting of migration-threshold=2 and failure-timeout=60s would cause the resource to move to a new node after 2 failures and potentially allow it to move back (depending on the stickiness and constraint scores) after one minute. + + There are two exceptions to the migration threshold concept and occur when a resource either fails to start or fails to stop. + Start failures cause the failcount to be set to INFINITY and thus always cause the resource to move immediately. + + + Stop failures are slightly different and crucial. + If a resource fails to stop and STONITH is enabled, then the cluster will fence the node in order to be able to start the resource elsewhere. + If STONITH is not enabled, then the cluster has no way to continue and will not try to start the resource elsewhere, but will try to stop it again after the failure timeout. + + Please read before enabling this option. +
    +
    + Moving Resources Due to Connectivity Changes + Setting up the cluster to move resources when external connectivity is lost, is a two-step process. +
    + Tell Pacemaker to monitor connectivity + + To do this, you need to add a ping resource to the cluster. + The ping resource uses the system utility of the same name to a test if list of machines (specified by DNS hostname or IPv4/ IPv6 address) are reachable and uses the results to maintain a node attribute normally called pingd. + + The attribute name is customizable which allows multiple ping groups to be defined + + + Older versions of Heartbeat required users to add ping nodes to ha.cf - this is no longer required. + + + + Older versions of Pacemaker used a custom binary called pingd for this functionality, this is now deprecated in favor of ping. + If your version of Pacemaker does not contain the ping agent, you can download the latest version from: + + + + Normally the resource will run on all cluster nodes, which means that you'll need to create a clone. + A template for this can be found below along with a description of the most interesting parameters. + + + Common Options for a 'ping' Resource + + + + Field + Description + + + + + dampen + The time to wait (dampening) for further changes occur. Use this to prevent a resource from bouncing around the cluster when cluster nodes notice the loss of connectivity at slightly different times. + + + multiplier + The number by which to multiply the number of connected ping nodes by. Useful when there are multiple ping nodes configured. + + + host_list + The machines to contact in order to determine the current connectivity status. Allowed values include resolvable DNS hostnames, IPv4 and IPv6 addresses. + + + +
    + + An example ping cluster resource, checks node connectivity once every minute + + + + + + + + + + + + + +]]> + + +
    +
    + Tell Pacemaker how to interpret the connectivity data + NOTE: Before reading the following, please make sure you have read and understood above. + + There are a number of ways to use the connectivity data provided by Heartbeat. + The most common setup is for people to have a single ping node and want to prevent the cluster from running a resource on any unconnected node. + + + Don't run on unconnected nodes + + + + + + +]]> + + + + A more complex setup is to have a number of ping nodes configured. + You can require the cluster to only run resources on nodes that can connect to all (or a minimum subset) of them + + + Run only on nodes connected to 3 or more ping nodes (assumes <literal>multiplier</literal> is set to 1000) + + + + + + +]]> + + + + or instead you can tell the cluster only to prefer nodes with the most connectivity. + Just be sure to set the multiplier to a value higher than that of resource-stickiness (and don't set either of them to INFINITY). + + + Prefer the node with the most connected ping nodes + + + + + + +]]> + + + + It is perhaps easier to think of this in terms of the simple constraints that the cluster translates it into. + For example, if sles-1 is connected to all 5 ping nodes but sles-2 is only connected to 2, then it would be as if you instead had the following constraints in your configuration: + +
    + How the cluster translates the pingd constraint + + + +]]> + +
    + The advantage being that you don't have to manually update them whenever your network connectivity changes. + + You can also combine the concepts above into something even more complex. + The example below shows how you can prefer the node with the most connected ping nodes provided they have connectivity to at least three (assuming multiplier is set to 1000). + + + A more complex example of choosing a location based on connectivity + + + + + + + + + +]]> + + +
    +
    +
    + Resource Migration + + Some resources, such as Xen virtual guests, are able to move to another location without lose of state. + We call this resource migration and is different from the normal practice of stopping the resource on the first machine and starting it elsewhere. + + + Not all resources are able to migrate, see the Migration Checklist below, and those that can wont do so in all situations. + Conceptually there are two requirements from which the other prerequisites follow: + + + the resource must be active and healthy at the old location + everything required for the resource to run must be available on both the old and new locations + + The cluster is able to accommodate both push and pull migration models by requiring the resource agent to support two new actions: migrate_to (performed on the current location) and migrate_from (performed on the destination). + + In push migration, the process on the current location transfers the to the new location where is it later activated. + In this scenario, most of the work would be done in the migrate_to action and, if anything, the activation would occur during migrate_from. + + Conversely for pull, the migrate_to action is practically empty and migrate_from does most of the work, extracting the relevant resource state from the old location and activating it. + There is no wrong or right way to implement migration for your service, as long as it works. +
    + Migration Checklist + + The resource may not be a clone. + The resource must use an OCF style agent. + The resource must not be in a failed or degraded state. + The resource must not, directly or indirectly, depend on any primitive or group resources. + The resources must support two new actions: migrate_to and migrate_from and advertise them in its metadata. + The resource must have the allow-migrate meta-attribute set to true (not the default). + + + If the resource depends on a clone, and at the time the resource needs to be move, the clone has instances that are stopping and instances that are starting, then the resource will be moved in the traditional manner. + The Policy Engine is not yet able to model this situation correctly and so takes the safe (yet less optimal) path. + +
    +
    +
    +
    + Reusing Rules, Options and Sets of Operations + + Sometimes a number of constraints need to use the same set of rules and resources need to set the same options an parameters. + To simplify this situation, you can refer to an existing object using an id-ref instead of an id. + + So if for one resource you have + + + + + + +]]> + + Then instead of duplicating the rule for all your other resources, you can instead specify + + Referencing rules from other constraints + + + + +]]> + + + + + The cluster will insist that the rule exists somewhere. + Attempting to add a reference to a non-existing rule will cause a validation failure, as will attempting to remove a rule that is referenced elsewhere. + + + The same principle applies for meta_attributes and instance_attributes as illustrated in the example below + + Referencing attributes, options and operations from other resources + + + + + + + + + + + + + + + + + + + + + +]]> + + + +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Advanced-Resources.xml b/doc/Pacemaker_Explained/en-US/Ch-Advanced-Resources.xml new file mode 100644 index 0000000000..fc9b6d0580 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Advanced-Resources.xml @@ -0,0 +1,897 @@ + Advanced Resource Types +
    + Groups - A Syntactic Shortcut + + One of the most common elements of a cluster is a set of resources that need to be located together, start sequentially and stop in the reverse order. + To simplify this configuration we support the concept of groups. + + + An example group + + + + + + + + + +]]> + + + + Although the example above contains only two resources, there is no limit to the number of resources a group can contain. + The example is also sufficient to explain the fundamental properties of a group: + + + Resources are started in the order they appear in (Public-IP first, then Email) + Resources are stopped in the reverse order to which they appear in (Email first, then Public-IP) + + If a resource in the group can't run anywhere, then nothing after that is allowed to run + + If Public-IP can’t run anywhere, neither can Email + If Email can’t run anywhere, this does not affect Public-IP in any way + + + + The group above is logically equivalent to writing: + + How the cluster sees a group resource + + + + + + + + + + + + + + + +]]> + + + Obviously as the group grows bigger, the reduced configuration effort can become significant. +
    + Properties + + Properties of a Group Resource + + + + Field + Description + + + + + id + Your name for the group + + + +
    +
    +
    + Options + Options inherited from simple resources: priority, target-role, is-managed +
    +
    + Using Groups +
    + Instance Attributes + Groups have no instance attributes, however any that are set here will be inherited by the group's children. +
    +
    + Contents + + Groups may only contain a collection of primitive cluster resources. + To refer to the child of a group resource, just use the child's id instead of the group's. + +
    +
    + Constraints + Although it is possible to reference the group's children in constraints, it is usually preferable to use the group's name instead. + + Example constraints involving groups + + + + + + +]]> + + +
    +
    + Stickiness + Stickiness, the measure of how much a resource wants to stay where it is, is additive in groups. +Every active member of the group will contribute its stickiness value to the group's total. +So if the default resource-stickiness is 100 a group has seven members, five of which are active, then the group as a whole will prefer its current location with a score of 500. +
    +
    +
    +
    + Clones - Resources That Should be Active on Multiple Hosts + + Clones were initially conceived as a convenient way to start N instances of an IP resource and have them distributed throughout the cluster for load balancing. + They have turned out to quite useful for a number of purposes including integrating with Red Hat's DLM, the fencing subsystem and OCFS2. + + You can clone any resource provided the resource agent supports it. + Three types of cloned resources exist. + + Anonymous + Globally Unique + Stateful + + + Anonymous clones are the simplest type. + These resources behave completely identically everywhere they are running. + Because of this, there can only be one copy of an anonymous clone active per machine. + + + Globally unique clones are distinct entities. + A copy of the clone running on one machine is not equivalent to another instance on another node. + Nor would any two copies on the same node be equivalent. + + Stateful clones are covered later in . + + An example clone + + + + + + + +]]> + + +
    + Properties + + Properties of a Clone Resource + + + + Field + Description + + + id + Your name for the clone + + + +
    +
    +
    + Options + Options inherited from simple resources: priority, target-role, is-managed + + Clone specific configuration options + + + + Field + Description + + + + + clone-max + How many copies of the resource to start. Defaults to the number of nodes in the cluster. + + + clone-node-max + How many copies of the resource can be started on a single node. Defaults to 1. + + + notify + When stopping or starting a copy of the clone, tell all the other copies beforehand and when the action was successful. Allowed values: true, false + + + + globally-unique + Does each copy of the clone perform a different function? Allowed values: true, false + + + ordered + Should the copies be started in series (instead of in parallel). Allowed values: true, false + + + + interleave + Changes the behavior of ordering constraints (between clones/masters) so that instances can start/stop as soon as their peer instance has (rather than waiting for every instance of the other clone has). Allowed values: true, false + + + + +
    +
    +
    + Using Clones +
    + Instance Attributes + Clones have no instance attributes, however any that are set here will be inherited by the clone's children. +
    +
    + Contents + Clones must contain exactly one group or one regular resource. + + + You should never reference the name of a clone's child. + If you think you need to do this, you probably need to re-evaluate your design. + + +
    +
    + Constraints + + In most cases, a clone will have a single copy on each active cluster node. + However if this is not the case, you can indicate which nodes the cluster should to preferentially assign copies to with resource location constraints. + These constraints are written no differently to those for regular resources except that the clone's id is used. + + + Ordering constraints behave slightly differently for clones. + In the example below, apache-stats will wait until all copies of the clone that need to be started have done so before being started itself. + Only if no copies can be started will apache-stats be prevented from being active. + Additionally, the clone will wait for apache-stats to be stopped before stopping the clone. + + + Colocation of a regular (or group) resource with a clone means that the resource can run on any machine with an active copy of the clone. + The cluster will choose a copy based on where the clone is running and the rsc resource's own location preferences. + + + Colocation between clones is also possible. + In such cases, the set of allowed locations for the rsc clone is limited to nodes on which the with clone is (or will be) active. + Allocation is then performed as-per-normal. + + + Example constraints involving clones + + + + + + +]]> + + +
    +
    + Stickiness + + To achieve a stable allocation pattern, clones are slightly sticky by default. + If no value for resource-stickiness is provided, the clone will use a value of 1. + Being a small value, it causes minimal disturbance to the score calculations of other resources but is enough to prevent Pacemaker from needlessly moving copies around the cluster. + +
    +
    + Resource Agent Requirements + + Any resource can be used as an anonymous clone as it requires no additional support from the resource agent. + Whether it makes sense to do so depends on your resource and its resource agent. + + + Globally unique clones do require some additional support in the resource agent. + In particular, it must only respond with ${OCF_SUCCESS} if the node has that exact instance active. + All other probes for instances of the clone should result in ${OCF_NOT_RUNNING}. + Unless of course they are failed, in which case they should return one of the other OCF error codes. + + Copies of a clone are identified by appending a colon and a numerical offset. Eg. apache:2 + Resource agents can find out how many copies there are by examining the OCF_RESKEY_CRM_meta_clone_max environment variable and which copy it is by examining OCF_RESKEY_CRM_meta_clone. + + You should not make any assumptions (based on OCF_RESKEY_CRM_meta_clone) about which copies are active. + In particular, the list of active copies will not always be an unbroken sequence, nor always start at 0. + +
    +
    + Notifications + + Supporting notifications requires the notify action to be implemented. + Once supported, the notify action will be passed a number of extra variables which, when combined with additional context, can be used to calculate the current state of the cluster and what is about to happen to it. + + + Environment variables supplied with Clone notify actions + + + + Variable + Description + + + + + OCF_RESKEY_CRM_meta_notify_type + Allowed values: pre, post + + + OCF_RESKEY_CRM_meta_notify_operation + Allowed values: start, stop + + + OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be started + + + OCF_RESKEY_CRM_meta_notify_stop_resource + Resources to be stopped + + + OCF_RESKEY_CRM_meta_notify_active_resource + Resources the that are running + + + OCF_RESKEY_CRM_meta_notify_inactive_resource + Resources the that are not running + + + OCF_RESKEY_CRM_meta_notify_start_uname + Nodes on which resources will be started + + + OCF_RESKEY_CRM_meta_notify_stop_uname + Nodes on which resources will be stopped + + + OCF_RESKEY_CRM_meta_notify_active_uname + Nodes on which resources are running + + + OCF_RESKEY_CRM_meta_notify_inactive_uname + Nodes on which resources are not running + + + +
    + The variables come in pairs, such as OCF_RESKEY_CRM_meta_notify_start_resource and OCF_RESKEY_CRM_meta_notify_start_uname and should be treated as an array of whitespace separated elements. + Thus in order to indicate that clone:0 will be started on sles-1, clone:2 will be started on sles-3, and clone:3 will be started on sles-2, the cluster would set + OCF_RESKEY_CRM_meta_notify_start_resource="clone:0 clone:2 clone:3" + OCF_RESKEY_CRM_meta_notify_start_uname="sles-1 sles-3 sles-2" + Example notification variables +
    +
    + Proper Interpretation of Notification Environment Variables + Pre-notification (stop) + + + Active resources: $OCF_RESKEY_CRM_meta_notify_active_resource + + + Inactive resources: $OCF_RESKEY_CRM_meta_notify_inactive_resource + + + Resources to be started: $OCF_RESKEY_CRM_meta_notify_start_resource + + + Resources to be stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + + + + Post-notification (stop) / Pre-notification (start) + + + Active resources: + + + $OCF_RESKEY_CRM_meta_notify_active_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + + + Inactive resources: + + + $OCF_RESKEY_CRM_meta_notify_inactive_resource + plus $OCF_RESKEY_CRM_meta_notify_stop_resource + + + Resources that were started: $OCF_RESKEY_CRM_meta_notify_start_resource + + + Resources that were stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + + + + Post-notification (start) + + + Active resources: + + + $OCF_RESKEY_CRM_meta_notify_active_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + plus $OCF_RESKEY_CRM_meta_notify_start_resource + + + Inactive resources: + + + $OCF_RESKEY_CRM_meta_notify_inactive_resource + plus $OCF_RESKEY_CRM_meta_notify_stop_resource + minus $OCF_RESKEY_CRM_meta_notify_start_resource + + + Resources that were started: $OCF_RESKEY_CRM_meta_notify_start_resource + + + Resources that were stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + + +
    +
    +
    +
    + Multi-state - Resources That Have Multiple Modes + + Multi-state resources are a specialization of Clones (please ensure you understand the section on clones before continuing) that allow the instances to be in one of two operating modes. + These modes are called Master and Slave but can mean whatever you wish them to mean. + The only limitation is that when an instance is started, it must come up in the Slave state. + +
    + Properties + + Properties of a Multi-State Resource + + + + Field + Description + + + id + Your name for the multi-state resource + + + +
    +
    +
    + Options + Options inherited from simple resources: priority, target-role, is-managed + Options inherited from clone resources: clone-max, clone-node-max, notify, globally-unique, ordered, interleave + + Multi-state specific resource configuration options + + + + Field + Description + + + master-max + How many copies of the resource can be promoted to master status. Defaults to 1. + + + master-node-max + How many copies of the resource can be promoted to master status on a single node. Defaults to 1. + +
    +
    +
    + Using Multi-state Resources +
    + Instance Attributes + Multi-state resources have no instance attributes, however any that are set here will be inherited by the master's children. +
    +
    + Contents + Masters must contain exactly one group or one regular resource. + + + You should never reference the name of a master's child. + If you think you need to do this, you probably need to re-evaluate your design. + + +
    +
    + Monitoring Multi-State Resources + + The normal type of monitor actions you define are not sufficient to monitor a multi-state resource in the Master state. + To detect failures of the master instance, you need to define an additional monitor action with role="Master". + + It is crucial that every monitor operation has a different interval + + Monitoring both states of a multi-state resource + + + + + + + + + +]]> + + +
    +
    + Constraints + + In most cases, a multi-state resources will have a single copy on each active cluster node. + However if this is not the case, you can indicate which nodes the cluster should to preferentially assign copies to with resource location constraints. + These constraints are written no differently to those for regular resources except that the master's id is used. + + + When considering multi-state resources in constraints, for most purposes it is sufficient to treat them as clones. + The exception is when the rsc-role and/or with-rsc-role (for colocation constraints) and first-action and/or then-action (for ordering constraints) are used. + + + Additional constraint options relevant to multi-state resources + + + + Field + Description + + + rsc-role + + An additional attribute of colocation constraints that specifies the role that rsc must be in. + Allowed values: Started, Master, Slave + + + + with-rsc-role + + An additional attribute of colocation constraints that specifies the role that with-rsc must be in. + Allowed values: Started, Master, Slave + + + + first-action + + An additional attribute of ordering constraints that specifies the action that the first resource must complete before executing the specified action for the then resource. + Allowed values: start, stop, promote, demote + + + + then-action + + An additional attribute of ordering constraints that specifies the action that the then resource can only execute after the first-action on the first resource has completed. + Allowed values: start, stop, promote, demote. Defaults to the value (specified or implied) of first-action + + + + +
    + + In the example below, myApp will wait until one of database copies has been started and promoted to master before being started itself. + Only if no copies can be promoted will apache-stats be prevented from being active. + Additionally, the database will wait for myApp to be stopped before it is demoted. + + + Colocation of a regular (or group) resource with a multi-state resource means that it can run on any machine with an active copy of the clone that is in the specified state (Master or Slave). + In the example, the cluster will choose a location based on where database is running as a Master, and if there are multiple Master instances it will also factor in myApp‘s own location preferences when deciding which location to choose. + + + Colocation with regular clones and other multi-state resources is also possible. + In such cases, the set of allowed locations for the rsc clone is (after role filtering) limited to nodes on which the with-rsc clone is (or will be) in the specified role. + Allocation is then performed as-per-normal. + + + Example constraints involving multi-state resources + + + + + + + + +]]> + + +
    +
    + Stickiness + + To achieve a stable allocation pattern, clones are slightly sticky by default. + If no value for resource-stickiness is provided, the clone will use a value of 1. + Being a small value, it causes minimal disturbance to the score calculations of other resources but is enough to prevent Pacemaker from needlessly moving copies around the cluster. + +
    +
    + Which Resource Instance is Promoted + + During the start operation, most Resource Agent scripts should call the crm_master utility. + This tool automatically detects both the resource and host and should be used to set a preference for being promoted. + Based on this, master-max, and master-node-max, the instance(s) with the highest preference will be promoted. + + The other alternative is to create a location constraint that indicates which nodes are most preferred as masters. + + Manually specifying which node should be promoted + + + + + + +]]> + + +
    +
    + Resource Agent Requirements + + Since multi-state resources are an extension of cloned resources, all the requirements of Clones are also requirements of multi-state resources. + Additionally, multi-state resources require two extra actions demote and promote. + These actions are responsible for changing the state of the resource. + Like start and stop, they should return OCF_SUCCESS if they completed successfully or a relevant error code if they did not. + + + The states can mean whatever you wish, but when the resource is started, it must come up in the mode called Slave. + From there the cluster will then decide which instances to promote into a Master. + + + In addition to the Clone requirements for monitor actions, agents must also accurately report which state they are in. + The cluster relies on the agent to report its status (including role) accurately and does not indicate to the agent what role it currently believes it to be in. + + + Role implications of OCF return codes + + + + Monitor Return Code + Description + + + OCF_NOT_RUNNING + Stopped + + + OCF_SUCCESS + Running (Slave) + + + OCF_RUNNING_MASTER + Running (Master) + + + OCF_FAILED_MASTER + Failed (Master) + + + Other + Failed (Slave) + +
    +
    +
    + Notifications + + Like with clones, supporting notifications requires the notify action to be implemented. + Once supported, the notify action will be passed a number of extra variables which, when combined with additional context, can be used to calculate the current state of the cluster and what is about to happen to it. + + + Environment variables supplied with Master notify actions + <footnote><para>Variables in bold are specific to Master resources and all behave in the same manner as described for Clone resources.</para></footnote> + + + + + Variable + Description + + + OCF_RESKEY_CRM_meta_notify_type + Allowed values: pre, post + + + OCF_RESKEY_CRM_meta_notify_operation + Allowed values: start, stop + + + OCF_RESKEY_CRM_meta_notify_active_resource + Resources the that are running + + + OCF_RESKEY_CRM_meta_notify_inactive_resource + Resources the that are not running + + + OCF_RESKEY_CRM_meta_notify_master_resource + Resources that are running in Master mode + + + OCF_RESKEY_CRM_meta_notify_slave_resource + Resources that are running in Slave mode + + + OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be started + + + OCF_RESKEY_CRM_meta_notify_stop_resource + Resources to be stopped + + + OCF_RESKEY_CRM_meta_notify_promote_resource + Resources to be promoted + + + OCF_RESKEY_CRM_meta_notify_demote_resource + Resources to be demoted + + + OCF_RESKEY_CRM_meta_notify_start_uname + Nodes on which resources will be started + + + OCF_RESKEY_CRM_meta_notify_stop_uname + Nodes on which resources will be stopped + + + OCF_RESKEY_CRM_meta_notify_promote_uname + Nodes on which resources will be promoted + + + OCF_RESKEY_CRM_meta_notify_demote_uname + Nodes on which resources will be demoted + + + OCF_RESKEY_CRM_meta_notify_active_uname + Nodes on which resources are running + + + OCF_RESKEY_CRM_meta_notify_inactive_uname + Nodes on which resources are not running + + + OCF_RESKEY_CRM_meta_notify_master_uname + Nodes on which resources are running in Master mode + + + OCF_RESKEY_CRM_meta_notify_slave_uname + Nodes on which resources are running in Slave mode + +
    +
    +
    + Proper Interpretation of Notification Environment Variables + Pre-notification (demote) + + Active resources: $OCF_RESKEY_CRM_meta_notify_active_resource + Master resources: $OCF_RESKEY_CRM_meta_notify_master_resource + Slave resources: $OCF_RESKEY_CRM_meta_notify_slave_resource + Inactive resources: $OCF_RESKEY_CRM_meta_notify_inactive_resource + Resources to be started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be promoted: $OCF_RESKEY_CRM_meta_notify_promote_resource + Resources to be demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources to be stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + + + Post-notification (demote) / Pre-notification (stop) + + Active resources: $OCF_RESKEY_CRM_meta_notify_active_resource + Master resources: + + $OCF_RESKEY_CRM_meta_notify_master_resource + minus $OCF_RESKEY_CRM_meta_notify_demote_resource + + Slave resources: $OCF_RESKEY_CRM_meta_notify_slave_resource + Inactive resources: $OCF_RESKEY_CRM_meta_notify_inactive_resource + Resources to be started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be promoted: $OCF_RESKEY_CRM_meta_notify_promote_resource + Resources to be demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources to be stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + Resources that were demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + + + Post-notification (stop) / Pre-notification (start) + + Active resources: + + $OCF_RESKEY_CRM_meta_notify_active_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + + Master resources: + + $OCF_RESKEY_CRM_meta_notify_master_resource + minus $OCF_RESKEY_CRM_meta_notify_demote_resource + + Slave resources: + + $OCF_RESKEY_CRM_meta_notify_slave_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + + Inactive resources: + + $OCF_RESKEY_CRM_meta_notify_inactive_resource + plus $OCF_RESKEY_CRM_meta_notify_stop_resource + + Resources to be started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be promoted: $OCF_RESKEY_CRM_meta_notify_promote_resource + Resources to be demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources to be stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + Resources that were demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources that were stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + + Post-notification (start) / Pre-notification (promote) + + Active resources: + + $OCF_RESKEY_CRM_meta_notify_active_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + plus $OCF_RESKEY_CRM_meta_notify_start_resource + + Master resources: + + $OCF_RESKEY_CRM_meta_notify_master_resource + minus $OCF_RESKEY_CRM_meta_notify_demote_resource + + Slave resources: + + $OCF_RESKEY_CRM_meta_notify_slave_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + plus $OCF_RESKEY_CRM_meta_notify_start_resource + + Inactive resources: + + $OCF_RESKEY_CRM_meta_notify_inactive_resource + plus $OCF_RESKEY_CRM_meta_notify_stop_resource + minus $OCF_RESKEY_CRM_meta_notify_start_resource + + Resources to be started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be promoted: $OCF_RESKEY_CRM_meta_notify_promote_resource + Resources to be demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources to be stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + Resources that were started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources that were demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources that were stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + + + Post-notification (promote) + + Active resources: + + $OCF_RESKEY_CRM_meta_notify_active_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + plus $OCF_RESKEY_CRM_meta_notify_start_resource + + Master resources: + + $OCF_RESKEY_CRM_meta_notify_master_resource + minus $OCF_RESKEY_CRM_meta_notify_demote_resource + plus $OCF_RESKEY_CRM_meta_notify_promote_resource + + Slave resources: + + $OCF_RESKEY_CRM_meta_notify_slave_resource + minus $OCF_RESKEY_CRM_meta_notify_stop_resource + plus $OCF_RESKEY_CRM_meta_notify_start_resource + minus $OCF_RESKEY_CRM_meta_notify_promote_resource + + Inactive resources: + + $OCF_RESKEY_CRM_meta_notify_inactive_resource + plus $OCF_RESKEY_CRM_meta_notify_stop_resource + minus $OCF_RESKEY_CRM_meta_notify_start_resource + + Resources to be started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources to be promoted: $OCF_RESKEY_CRM_meta_notify_promote_resource + Resources to be demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources to be stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + Resources that were started: $OCF_RESKEY_CRM_meta_notify_start_resource + Resources that were promoted: $OCF_RESKEY_CRM_meta_notify_promote_resource + Resources that were demoted: $OCF_RESKEY_CRM_meta_notify_demote_resource + Resources that were stopped: $OCF_RESKEY_CRM_meta_notify_stop_resource + +
    +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Basics.xml b/doc/Pacemaker_Explained/en-US/Ch-Basics.xml new file mode 100644 index 0000000000..43b979eeb4 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Basics.xml @@ -0,0 +1,308 @@ + Configuration Basics +
    + Configuration Layout + The cluster is written using XML notation and divided into two main sections; configuration and status. + + The status section contains the history of each resource on each node and based on this data, the cluster can construct the complete current state of the cluster. + The authoritative source for the status section is the local resource manager (lrmd) process on each cluster node and the cluster will occasionally repopulate the entire section. + For this reason it is never written to disk and admin's are advised against modifying it in any way. + + + The configuration section contains the more traditional information like cluster options, lists of resources and indications of where they should be placed. + The configuration section is the primary focus of this document. + + The configuration section itself is divided into four parts: + + Configuration options (called crm_config) + Nodes + Resources + Resource relationships (called constraints) + + + An empty configuration + + + + + + + + + + +]]> + + +
    +
    + The Current State of the Cluster + + Before one starts to configure a cluster, it is worth explaining how to view the finished product. + For this purpose we have created the crm_mon utility that will display the current state of an active cluster. + It can show the cluster status by node or by resource and can be used in either single-shot or dynamically-updating mode. + There are also modes for displaying a list of the operations performed (grouped by node and resource) as well as information about failures. + + Using this tool, you can examine the state of the cluster for irregularities and see how it responds when you cause or simulate failures. + Details on all the available options can be obtained using the crm_mon --help command. +
    + Sample output from crm_mon + + # crm_mon + ============ + Last updated: Fri Nov 23 15:26:13 2007 + Current DC: sles-3 (2298606a-6a8c-499a-9d25-76242f7006ec) + 3 Nodes configured. + 5 Resources configured. + ============ + + Node: sles-1 (1186dc9a-324d-425a-966e-d757e693dc86): online + 192.168.100.181 (heartbeat::ocf:IPaddr): Started sles-1 + 192.168.100.182 (heartbeat:IPaddr): Started sles-1 + 192.168.100.183 (heartbeat::ocf:IPaddr): Started sles-1 + rsc_sles-1 (heartbeat::ocf:IPaddr): Started sles-1 + child_DoFencing:2 (stonith:external/vmware): Started sles-1 + Node: sles-2 (02fb99a8-e30e-482f-b3ad-0fb3ce27d088): standby + Node: sles-3 (2298606a-6a8c-499a-9d25-76242f7006ec): online + rsc_sles-2 (heartbeat::ocf:IPaddr): Started sles-3 + rsc_sles-3 (heartbeat::ocf:IPaddr): Started sles-3 + child_DoFencing:0 (stonith:external/vmware): Started sles-3 +
    +
    + Sample output from crm_mon -n + + # crm_mon -n + ============ + Last updated: Fri Nov 23 15:26:13 2007 + Current DC: sles-3 (2298606a-6a8c-499a-9d25-76242f7006ec) + 3 Nodes configured. + 5 Resources configured. + ============ + + Node: sles-1 (1186dc9a-324d-425a-966e-d757e693dc86): online + Node: sles-2 (02fb99a8-e30e-482f-b3ad-0fb3ce27d088): standby + Node: sles-3 (2298606a-6a8c-499a-9d25-76242f7006ec): online + + Resource Group: group-1 + 192.168.100.181 (heartbeat::ocf:IPaddr): Started sles-1 + 192.168.100.182 (heartbeat:IPaddr): Started sles-1 + 192.168.100.183 (heartbeat::ocf:IPaddr): Started sles-1 + rsc_sles-1 (heartbeat::ocf:IPaddr): Started sles-1 + rsc_sles-2 (heartbeat::ocf:IPaddr): Started sles-3 + rsc_sles-3 (heartbeat::ocf:IPaddr): Started sles-3 + Clone Set: DoFencing + child_DoFencing:0 (stonith:external/vmware): Started sles-3 + child_DoFencing:1 (stonith:external/vmware): Stopped + child_DoFencing:2 (stonith:external/vmware): Started sles-1 +
    + + The DC (Designated Controller) node is where all the decisions are made and if the current DC fails a new one is elected from the remaining cluster nodes. + The choice of DC is of no significance to an administrator beyond the fact that its logs will generally be more interesting. + +
    +
    + How Should the Configuration be Updated? + There are three basic rules for updating the cluster configuration: + + Rule 1 - Never edit the cib.xml file manually. Ever. I'm not making this up. + Rule 2 - Read Rule 1 again. + Rule 3 - The cluster will notice if you ignored rules 1 & 2 and refuse to use the configuration. + + Now that it is clear how NOT to update the configuration, we can begin to explain how you should. + + The most powerful tool for modifying the configuration is the cibadmin command which talks to a running cluster. + With cibadmin, the user can query, add, remove, update or replace any part of the configuration and all changes take effect immediately so there is no need to perform a reload-like operation. + + The simplest way of using cibadmin is to us it to save the current configuration to a temporary file, edit that file with your favorite text or XML editor and then upload the revised configuration. +
    + Safely using an editor to modify the cluster configuration + + cibadmin --query > tmp.xml + vi tmp.xml + cibadmin --replace --xml-file tmp.xml + +
    + + Some of the better XML editors can make use of a Relax NG schema to help make sure any changes you make are valid. + The schema describing the configuration can normally be found in /usr/lib/heartbeat/pacemaker.rng on most systems. + + If you only wanted to modify the resources section, you could instead do +
    + Safely using an editor to modify a subsection of the cluster configuration + + cibadmin --query --obj_type resources > tmp.xml + vi tmp.xml + cibadmin --replace --obj_type resources --xml-file tmp.xml + +
    + to avoid modifying any other part of the configuration. +
    +
    + Quickly Deleting Part of the Configuration + Identify the object you wish to delete. eg. + + + Next identify the resource's tag name and id (in this case we'll chose primitive and child_DoFencing). + Then simply execute: + + cibadmin --delete --crm_xml ‘<primitive id="child_DoFencing"/>' +
    +
    + Updating the Configuration Without Using XML + Some common tasks can also be performed with one of the higher level tools that avoid the need to read or edit XML. + To enable stonith for example, one could run: + crm_attribute --attr-name stonith-enabled --attr-value true + Or to see if somenode is allowed to run resources, there is: + crm_standby --get-value --node-uname somenode + Or to find the current location of my-test-rsc one can use: + crm_resource --locate --resource my-test-rsc +
    +
    + Making Configuration Changes in a Sandbox + + Often it is desirable to preview the effects of a series of changes before updating the configuration atomically. + For this purpose we have created crm_shadow which creates a "shadow" copy of the configuration and arranges for all the command line tools to use it. + + + To begin, simply invoke crm_shadow and give it the name of a configuration to create + + Shadow copies are identified with a name, making it possible to have more than one + and be sure to follow the simple on-screen instructions. + Read the above carefully, failure to do so could result in you destroying the cluster's active configuration + +
    + Creating and displaying the active sandbox + + # crm_shadow --create test + Setting up shadow instance + Type Ctrl-D to exit the crm_shadow shell + shadow[test]: + shadow[test] # crm_shadow --which + test +
    + + From this point on, all cluster commands will automatically use the shadow copy instead of talking to the cluster's active configuration. + Once you have finished experimenting, you can either commit the changes, or discard them as shown below. + Again, be sure to follow the on-screen instructions carefully. + + For a full list of crm_shadow options and commands, invoke it with the --help option. + + Using a sandbox to make multiple changes atomically + + shadow[test] # crm_failcount -G -r rsc_c001n01 + name=fail-count-rsc_c001n01 value=0 + shadow[test] # crm_standby -v on -n c001n02 + shadow[test] # crm_standby -G -n c001n02 + name=c001n02 scope=nodes value=on + shadow[test] # cibadmin --erase --force + shadow[test] # cibadmin --query + + + + + + + + + +]]> + shadow[test] # crm_shadow --delete test --force + Now type Ctrl-D to exit the crm_shadow shell + shadow[test] # exit + # crm_shadow --which + No shadow instance provided + # cibadmin -Q + + + + + + +]]> + + Making changes in a sandbox and verifying the real configuration is untouched + +
    +
    + Testing Your Configuration Changes + + We saw previously how to make a series of changes to a "shadow" copy of the configuration. + Before loading the changes back into the cluster (eg. crm_shadow --commit mytest --force), it is often advisable to simulate the effect of the changes with ptest. Eg. + + ptest --live-check -VVVVV --save-graph tmp.graph --save-dotfile tmp.dot + + The tool uses the same library as the live cluster to show what it would have done given the supplied input. + It's output, in addition to a significant amount of logging, is stored in two files tmp.graph and tmp.dot, both are representations of the same thing -- the cluster's response to your changes. + In the graph file is stored the complete transition, containing a list of all the actions, their parameters and their pre-requisites. + Because the transition graph is not terribly easy to read, the tool also generates a Graphviz dot-file representing the same information. + + +
    + Small Cluster Transition + + + + + An example transition graph as represented by Graphviz + +
    +     + Interpreting the Graphviz output + + Arrows indicate ordering dependencies + Dashed-arrows indicate dependencies that are not present in the transition graph + Actions with a dashed border of any color do not form part of the transition graph + Actions with a green border form part of the transition graph + Actions with a red border are ones the cluster would like to execute but are unrunnable + Actions with a blue border are ones the cluster does not feel need to be executed + Actions with orange text are pseudo/pretend actions that the cluster uses to simplify the graph + Actions with black text are sent to the LRM + Resource actions have text of the form {rsc}_{action}_{interval} {node} + Any action depending on an action with a red border will not be able to execute. + Loops are really bad. Please report them to the development team. + + + In the above example, it appears that a new node, node2, has come online and that the cluster is checking to make sure rsc1, rsc2 and rsc3 are not already running there (Indicated by the *_monitor_0 entries). + Once it did that, and assuming the resources were not active there, it would have liked to stop rsc1 and rsc2 on node1 and move them to node2. + However, there appears to be some problem and the cluster cannot or is not permitted to perform the stop actions which implies it also cannot perform the start actions. + For some reason the cluster does not want to start rsc3 anywhere. + + For information on the options supported by ptest, use ptest --help + +
    + Complex Cluster Transition + + + + + Another, slightly more complex, transition graph that you're not expected to be able to read + +
    +     +
    +
    + Do I Need to Update the Configuration on all Cluster Nodes? + No. Any changes are immediately synchronized to the other active members of the cluster. + To reduce bandwidth, the cluster only broadcasts the incremental updates that result from your changes and uses MD5 sums to ensure that each copy is completely consistent. +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Constraints.xml b/doc/Pacemaker_Explained/en-US/Ch-Constraints.xml new file mode 100644 index 0000000000..ea735e84e9 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Constraints.xml @@ -0,0 +1,547 @@ + Resource Constraints +
    + Scores + + Scores of all kinds are integral to how the cluster works. + Practically everything from moving a resource to deciding which resource to stop in a degraded cluster is achieved by manipulating scores in some way. + + + Scores are calculated on a per-resource basis and any node with a negative score for a resource can't run that resource. + After calculating the scores for a resource, the cluster then chooses the node with the highest one. + +
    + Infinity Math + INFINITY is currently defined as 1,000,000 and addition/subtraction with it follows the following 3 basic rules: + + Any value + INFINITY = INFINITY + Any value - INFINITY = -INFINITY + INFINITY - INFINITY = -INFINITY + +
    +
    +
    + Deciding Which Nodes a Resource Can Run On + + There are two alternative strategies for specifying which nodes a resources can run on. + One way is to say that by default they can run anywhere and then create location constraints for nodes that are not allowed. + The other option is to have nodes "opt-in"... + to start with nothing able to run anywhere and selectively enable allowed nodes. + +
    + Options + + Options for Simple Location Constraints + + + + Field + Description + + + id + A unique name for the constraint + + + rsc + A resource name + + + node + A node's uname + + + score + Positive values indicate the resource can run on this node. Negative values indicate the resource can not run on this node. Values of +/- INFINITY change "can" to "must". + + + +
    +
    +
    + Asymmetrical "Opt-In" Clusters + To create an opt-in cluster, start by preventing resources from running anywhere by default + crm_attribute --attr-name symmetric-cluster --attr-value false + + Then start enabling nodes. + The following fragment says that the web server prefers sles-1, the database prefers sles-2 and both can failover to sles-3 if their most preferred node fails. + + + Example set of opt-in location constraints + + + + + + + +]]> + + +
    +
    + Symmetrical "Opt-Out" Clusters + To create an opt-out cluster, start by allowing resources to run anywhere by default + crm_attribute --attr-name symmetric-cluster --attr-value true + + Then start disabling nodes. + The following fragment is the equivalent of the above opt-in configuration. + + + Example set of opt-out location constraints + + + + + + + +]]> + + + + Whether you should choose opt-in or opt-out depends both on your personal preference and the make-up of your cluster. + If most of your resources can run on most of the nodes, then an opt-out arrangement is likely to result in a simpler configuration. + On the other-hand, if most resources can only run on a small subset of nodes an opt-in configuration might be simpler. + +
    +
    + What if Two Nodes Have the Same Score + + If two nodes have the same score, then the cluster will choose one. + This choice may seem random and may not be what was intended, however the cluster was not given enough information to know what was intended. + + + Example of two resources that prefer two nodes equally + + + + + + + + +]]> + + + + In the example above, assuming no other constraints and an inactive cluster, Webserver would probably be placed on sles-1 and Database on sles-2. + It would likely have placed Webserver based on the node's uname and Database based on the desire to spread the resource load evenly across the cluster. + However other factors can also be involved in more complex configurations. + +
    +
    +
    + Specifying the Order Resources Should Start/Stop In + The way to specify the order in which resources should start is by creating rsc_order constraints. + + Properties of an Ordering Constraint + + + + Field + Description + + + + + id + A unique name for the constraint + + + first + The name of a resource that must be started before the then resource is allowed to. + + + then + The name of a resource. This resource will start after the first resource. + + + score + If greater than zero, the constraint is mandatory. Otherwise it is only a suggestion. Default value: INFINITY + + + + symmetrical + If true, which is the default, stop the resources in the reverse order. Default value: true + + + +
    +
    + Mandatory Ordering + + When the then resource cannot run without the first resource being active, one should use mandatory constraints. + To specify a constraint is mandatory, use a scores greater than zero. + This will ensure that the then resource will react when the first resource changes state. + + + If the first resource was running and is stopped, the then resource will also be stopped (if it is running) + If the first resource was not running and cannot be started, the then resource will be stopped (if it is running) + If the first resource is (re)started while the then resource is running, the then resource will be stopped and restarted + +
    +
    + Advisory Ordering + + On the other-hand, when score="0" is specified for a constraint, the constraint is considered optional and only has an effect when both resources are stopping and or starting. + Any change in state by the first resource will have no effect on the then resource. + + + Example of an optional and mandatory ordering constraint + + + + + +]]> + + + Some additional information on ordering constraints can be found in the document Ordering Explained + +
    +
    +
    + Placing Resources Relative to other Resources + When the location of one resource depends on the location of another one, we call this colocation. + + There is an important side-effect of creating a colocation constraint between two resources, that it affects the order in which resources are assigned to a node. + If you think about it, its somewhat obvious. + You can't place A relative to B unless you know where B is + + While the human brain is sophisticated enough to read the constraint in any order and choose the correct one depending on the situation, the cluster is not quite so smart. Yet. + . + So when you are creating colocation constraints, it is important to consider whether you should colocate A with B or B with A. + + + Another thing to keep in mind is that, assuming A is collocated with B, the cluster will also take into account A's preferences when deciding which node to choose for B. + For a detailed look at exactly how this occurs, see the Colocation Explained document. + +
    + Options + + Properties of a Collocation Constraint + + + + Field + Description + + + + + id + A unique name for the constraint + + + rsc + The colocation source. If the constraint cannot be satisfied, the cluster may decide not to allow the resource to run at all. + + + with-rsc + The colocation target. The cluster will decide where to put this resource first and then decide where to put the resource in the rsc field + + + score + Positive values indicate the resource should run on the same node. Negative values indicate the resources should not run on the same node. Values of +/- INFINITY change "should" to "must". + + + +
    +
    +
    + Mandatory Placement + + Mandatory placement occurs any time the constraint's score is +INFINITY or -INFINITY. + In such cases, if the constraint can't be satisfied, then the rsc resource is not permitted to run. + For score=INFINITY, this includes cases where the with-rsc resource is not active. + + If you need resource1 to always run on the same machine as resource2, you would add the following constraint: + + An example colocation constraint + + <rsc_colocation id="colocate" rsc="resource1" with-rsc="resource2" score="INFINITY"/> + + + Remember, because INFINITY was used, if resource2 can't run on any of the cluster nodes (for whatever reason) then resource1 will not be allowed to run. + + Alternatively, you may want the opposite... + that resource1 cannot run on the same machine as resource2. + In this case use score="-INFINITY" + + + An example anti-colocation constraint + + <rsc_colocation id="anti-colocate" rsc="resource1" with-rsc="resource2" score="-INFINITY"/> + + + + Again, by specifying -INFINTY, the constraint is binding. + So if the only place left to run is where resource2 already is, then resource1 may not run anywhere. + +
    +
    + Advisory Placement + + If mandatory placement is about "must" and "must not", then advisory placement is the "I'd prefer if" alternative. + For constraints with scores greater than -INFINITY and less than INFINITY, the cluster will try and accommodate your wishes but may ignore them if the alternative is to stop some of the cluster resources. + + Like in life, where if enough people prefer something it effectively becomes mandatory, advisory colocation constraints can combine with other elements of the configuration to behave as if they were mandatory. + + An example advisory-only colocation constraint + + <rsc_colocation id="colocate-maybe" rsc="resource1" with-rsc="resource2" score="500"/> + + +
    +
    +
    + Ordering Sets of Resources + A common situation is for an administrator to create a chain of ordered resources, such as: + + A chain of ordered resources + + + + + + +]]> + + + +
    + Ordered Set + + + + + Visual representation of the four resources' start order for the above constraints + +
    +     + To simplify this situation, there is an alternate format for ordering constraints + + A chain of ordered resources expressed as a set + + + + + + + + + + + +]]> + + + Resource sets have the opposite ordering semantics to groups. + + A group resource with the equivalent ordering rules + + + + + + + +]]> + + + + While the set-based format is not less verbose, it is significantly easier to get right and maintain. + It can also be expanded to allow ordered sets of (un)ordered resources. + In the example below, rscA and rscB can both start in parallel, as can rscC and rscD, however rscC and rscD can only start once both rscA and rscB are active. + + Ordered sets of unordered resources + + + + + + + + + + + + + +]]> + + + +
    + Two Sets of Unordered Resources + + + + + Visual representation of the start order for two ordered sets of unordered resources + +
    +     + Of course either or both sets of resources can also be internally ordered (by setting sequential="true") and there is no limit to the number of sets that can be specified. + + Advanced use of set ordering - Three ordered sets, two of which are internally unordered + + + + + + + + + + + + + + + + + +]]> + + + +
    + Three Resources Sets + + + + + Visual representation of the start order for the three sets defined above + +
    +     +
    +
    + Collocating Sets of Resources + + Another common situation is for an administrator to create a set of collocated resources. + Previously this possible either by defining a resource group (See ) which could not always accurately express the design; or by defining each relationship as an individual constraint, causing a constraint explosion as the number of resources and combinations grew. + + + A chain of collocated resources + + + + + + +]]> + + + + To make things easier, we allow an alternate form of colocation constraints using resource_sets. + Just like the expanded version, a resource that can't be active also prevents any resource that must be collocated with it from being active. + For example if B was not able to run, then both C (and by inference D) must also remain stopped. + + + The equivalent colocation chain expressed using resource_sets + + + + + + + + + + + +]]> + + + Resource sets have the same colocation semantics as groups. + + A group resource with the equivalent colocation rules + + + + + + + +]]> + + + + This notation can also be used in this context to tell the cluster that a set of resources must all be located with a common peer, but have no dependencies on each other. + In this scenario, unlike the previous on, B would be allowed to remain active even if A or C (or both) were inactive. + + + Using colocation sets to specify a common peer. + + + + + + + + + + + + + +]]> + + + + Of course there is no limit to the number and size of the sets used. + The only thing that matters is that in order for any member of set N to be active, all the members of set N+1 must also be active (and naturally on the same node), and that if a set has sequential="true", then in order for member M to be active, member M+1 must also be active. + You can even specify the role in which the members of a set must be in using the set's role attribute. + + + A colocation chain where the members of the middle set have no inter-dependencies and the last has master status. + + + + + + + + + + + + + + + + + + +]]> + + + +
    + Another Three Resources Sets + + + + + Visual representation of a colocation chain where the members of the middle set have no inter-dependencies + +
    +     +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Intro.xml b/doc/Pacemaker_Explained/en-US/Ch-Intro.xml new file mode 100644 index 0000000000..139165612a --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Intro.xml @@ -0,0 +1,175 @@ + Read-Me-First +
    + The Scope of this Document + + The purpose of this document is to definitively explain the concepts used to configure Pacemaker. + To achieve this best, it will focus exclusively on the XML syntax used to configure the CIB. + + + For those that are allergic to XML, Pacemaker comes with a cluster shell and a Python based GUI exists, however these tools will not be covered at all in this document + + It is hoped however, that having understood the concepts explained here, that the functionality of these tools will also be more readily understood. + + , precisely because they hide the XML. + + + Additionally, this document is NOT a step-by-step how-to guide for configuring a specific clustering scenario. + Although such guides exist, the purpose of this document is to provide an understanding of the building blocks that can be used to construct any type of Pacemaker cluster. + +
    +
    + What Is Pacemaker? + + Pacemaker is a cluster resource manager. + It achieves maximum availability for your cluster services (aka. resources) by detecting and recovering from node and resource-level failures by making use of the messaging and membership capabilities provided by your preferred cluster infrastructure (either OpenAIS or Heartbeat). + + Pacemaker's key features include: + + Detection and recovery of node and service-level failures + Storage agnostic, no requirement for shared storage + Resource agnostic, anything that can be scripted can be clustered + Supports STONITH for ensuring data integrity + Supports large and small clusters + Supports both quorate and resource driven clusters + Supports practically any redundancy configuration + Automatically replicated configuration that can be updated from any node + Ability to specify cluster-wide service ordering, colocation and anti-colocation + Support for advanced services type + + Clones: for services which need to be active on multiple nodes + Multi-state: for services with multiple modes (eg. master/slave, primary/secondary) + + + Unified, scriptable, cluster shell + +
    +
    + Types of Pacemaker Clusters + Pacemaker makes no assumptions about your environment, this allows it to support practically any redundancy configuration including Active/Active, Active/Passive, N+1, N+M, N-to-1 and N-to-N. + + +
    + Active/Passive Redundancy + + + + + Two-node Active/Passive clusters using Pacemaker and DRBD are a cost-effective solution for many High Availability situations. + +
    +     + +
    + N plus 1 Redundancy + + + + + By supporting many nodes, Pacemaker can dramatically reduce hardware costs by allowing several active/passive clusters to be combined and share a common backup node + +
    +     + +
    + N to N Redundancy + + + + + + When shared storage is available, every node can potentially be used for failover. + Pacemaker can even run multiple copies of services to spread out the workload. + + +
    +     +
    +
    + Pacemaker Architecture + At the highest level, the cluster is made up of three pieces: + + + Core cluster infrastructure providing messaging and membership functionality (illustrated in red) + + + Non-cluster aware components (illustrated in blue). + In a Pacemaker cluster, these pieces include not only the scripts that knows how to start, stop and monitor resources, but also a local daemon that masks the differences between the different standards these scripts implement. + + + A brain (illustrated in green) that processes and reacts to events from the cluster (nodes leaving or joining) and resources (eg. monitor failures) as well as configuration changes from the administrator. + In response to all of these events, Pacemaker will compute the ideal state of the cluster and plot a path to achieve it. + This may include moving resources, stopping nodes and even forcing them offline with remote power switches. + + + +
    + Conceptual Stack Overview + + + + + Conceptual overview of the cluster stack + +
    +     + When combined with OpenAIS, Pacemaker also supports popular open source cluster filesystems + + + Even though Pacemaker also supports Heartbeat, the filesystems need to use the stack for messaging and membership and OpenAIS seems to be what they're standardizing on. + Technically it would be possible for them to support Heartbeat as well, however there seems little interest in this. + + + Due to recent standardization within the cluster filesystem community, they make use of a common distributed lock manager which makes use of OpenAIS for its messaging capabilities and Pacemaker for its membership (which nodes are up/down) and fencing services. + + +
    + The Pacemaker Stack + + + + + The Pacemaker stack when running on OpenAIS + +
    +     +
    + Internal Components + Pacemaker itself is composed of four key components (illustrated below in the same color scheme as the previous diagram): + + CIB (aka. Cluster Information Base) + CRMd (aka. Cluster Resource Management daemon) + PEngine (aka. PE or Policy Engine) + STONITHd + + +
    + Internal Components + + + + + Subsystems of a Pacemaker cluster running on OpenAIS + +
    +     + + The CIB uses XML to represent both the cluster's configuration and current state of all resources in the cluster. + The contents of the CIB are automatically kept in sync across the entire cluster and are used by the PEngine to compute the ideal state of the cluster and how it should be achieved. + + + This list of instructions is then fed to the DC (Designated Co-ordinator). + Pacemaker centralizes all cluster decision making by electing one of the CRMd instances to act as a master. + Should the elected CRMd process, or the node it is on, fail... + a new one is quickly established. + + The DC carries out the PEngine's instructions in the required order by passing them to either the LRMd (Local Resource Management daemon) or CRMd peers on other nodes via the cluster messaging infrastructure (which in turn passes them on to their LRMd process). + The peer nodes all report the results of their operations back to the DC and based on the expected and actual results, will either execute any actions that needed to wait for the previous one to complete, or abort processing and ask the PEngine to recalculate the ideal cluster state based on the unexpected results. + + In some cases, it may be necessary to power off nodes in order to protect shared data or complete resource recovery. + For this Pacemaker comes with STONITHd. + STONITH is an acronym for Shoot-The-Other-Node-In-The-Head and is usually implemented with a remote power switch. + In Pacemaker, STONITH devices are modeled as resources (and configured in the CIB) to enable them to be easily monitored for failure, however STONITHd takes care of understanding the STONITH topology such that its clients simply request a node be fenced and it does the rest. + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Nodes.xml b/doc/Pacemaker_Explained/en-US/Ch-Nodes.xml new file mode 100644 index 0000000000..a867b73931 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Nodes.xml @@ -0,0 +1,109 @@ + + Cluster Nodes +
    + Defining a Cluster Node + Each node in the cluster will have an entry in the nodes section containing its UUID, uname and type. + + Example cluster node entry + + ]]> + + + + In normal circumstances, the admin should let the cluster populate this information automatically from the communications and membership data. + However one can use the crm_uuid tool to read an existing UUID or define a value before the cluster starts. + +
    +
    + Describing a Cluster Node + + Beyond the basic definition of a node, the administrator can also describe the node's attributes, such as how much RAM, disk, what OS or kernel version it has, perhaps even its physical location. + This information can then be used by the cluster when deciding where to place resources. + For more information on the use of node attributes, see the section on . + + Node attributes can be specified ahead of time or populated later, when the cluster is running, using crm_attribute. + Below is what the node's definition would look like if the admin ran the command: +
    + The result of using crm_attribute to specify which kernel sles-1 is running + + crm_attribute --type nodes --node-uname sles-1 --attr-name kernel --attr-value `uname -r` + + + + + +]]> + +
    + A simpler way to determine the current value of an attribute is to use crm_attribute command again: + crm_attribute --type nodes --node-uname sles-1 --attr-name kernel --get-value + + + By specifying --type nodes the admin tells the cluster that this attribute is persistent. + There are also transient attributes which are kept in the status section which are "forgotten" whenever the node rejoins the cluster. + The cluster uses this area to store a record of how many times a resource has failed on that node but administrators can also read and write to this section by specifying --type status. + +
    +
    + Adding a New Cluster Node +
    + OpenAIS + Adding a new is as simple as installing OpenAIS and Pacemaker, and copying /etc/ais/openais.conf and /etc/ais/authkey (if it exists) from an existing node. +You may need to modify the mcastaddr option to match the new node's IP address. + If a log message containing "Invalid digest" appears from OpenAIS, the keys are not consistent between the machines. +
    +
    + Heartbeat + Provided you specified autojoin any in ha.cf, adding a new is as simple as installing heartbeat and copying ha.cf and authkeys from an existing node. + If not, then after setting up ha.cf and authkeys, you must use the hb_addnode command before starting the new node. +
    +
    +
    + Removing a Cluster Node +
    + OpenAIS + TBA +
    +
    + Heartbeat + + Because the messaging and membership layers are the authoritative source for cluster nodes, deleting them from the CIB is not a reliable solution. + First one must arrange for heartbeat to forget about the node (sles-1 in the example below). + To do this, shut down heartbeat on the node and then, from one of the remaining active cluster nodes, run: + + hb_delnode sles-1 + Only then is it safe to delete the node from the CIB with: + cibadmin --delete --obj_type nodes --crm_xml ‘<node uname="sles-1"/>' + cibadmin --delete --obj_type status --crm_xml ‘<node_status uname="sles-1"/>' +
    +
    +
    + Replacing a Cluster Node +
    + OpenAIS + The five-step guide to replacing an existing cluster node: + + Make sure the old node is completely stopped + Give the new machine the same hostname and IP address as the old one + Install the cluster software :-) + Copy /etc/ais/openais.conf and /etc/ais/authkey (if it exists) to the new node + Start the new cluster node + + If a log message containing "Invalid digest" appears from OpenAIS, the keys are not consistent between the machines. +
    +
    + Heartbeat + The seven-step guide to replacing an existing cluster node: + + Make sure the old node is completely stopped + Give the new machine the same hostname as the old one + Go to an active cluster node and look up the UUID for the old node in /var/lib/heartbeat/hostcache + Install the cluster software + Copy ha.cf and authkeys to the new node + On the new node, populate it's UUID using crm_uuid -w and the UUID from step 2 + Start the new cluster node + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Options.xml b/doc/Pacemaker_Explained/en-US/Ch-Options.xml new file mode 100644 index 0000000000..04dea36e86 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Options.xml @@ -0,0 +1,252 @@ + + Cluster Options +
    + Special Options + + The reason for these fields to be placed at the top level instead of with the rest of cluster options is simply a matter of parsing. + These options are used by the configuration database which is, by design, mostly ignorant of the content it holds. + So the decision was made to place them in an easy to find location. + +
    + Configuration Version + + When a node joins the cluster, the cluster will perform a check to see who has the best configuration based on the fields below. + It then asks the node with the highest (admin_epoch, epoch, num_updates) tuple to replace the configuration on all the nodes - which makes setting them and setting them correctly very important. + + + Configuration Version Properties + + + + + Field + Description + + + + + admin_epoch + + Never modified by the cluster. Use this to make the configurations on any inactive nodes obsolete. + Never set this value to zero, in such cases the cluster cannot tell the difference between your configuration and the "empty" one used when nothing is found on disk. + + + + epoch + Incremented every time the configuration is updated (usually by the admin) + + + num_updates + Incremented every time the configuration or status is updated (usually by the cluster) + + + +
    +
    +
    + Other Fields + + Properties Controling Validation + + + + Field + Description + + + + + validate-with + + Determines the type of validation being done on the configuration. + If set to "none", the cluster will not verify that updates conform the the DTD (nor reject ones that don't). This option can be useful when operating a mixed version cluster during an upgrade. + + + + +
    +
    +
    + Fields Maintained by the Cluster + + Properties Maintained by the Cluster + + + + Field + Description + + + + + crm-debug-origin + Indicates where the last update came from. Informational purposes only. + + + cib-last-written + Indicates when the configuration was last written to disk. Informational purposes only. + + + dc-uuid + Indicates which cluster node is the current leader. Used by the cluster when placing resources and determining the order of some events. + + + have-quorum + Indicates if the cluster has quorum. If false, this may mean that the cluster cannot start resources or fence other nodes. See no-quorum-policy below. + + + +
    + + Note that although these fields can be written to by the admin, in most cases the cluster will overwrite any values specified by the admin with the "correct" ones. + To change the admin_epoch, for example, one would use: + + cibadmin --modify --crm_xml ‘<cib admin_epoch="42"/>' + A complete set of fields will look something like this: + + An example of the fields set for a cib object + + +]]> + + +
    +
    +
    + Cluster Options + Cluster options, as you'd expect, control how the cluster behaves when confronted with certain situations. + They are grouped into sets and, in advanced configurations, there may be more than one. + This will be described later in the section on where we will show how to have the cluster use different sets of options during working hours (when downtime is usually to be avoided at all costs) than it does during the weekends (when resources can be moved to the their preferred hosts without bothering end users) + For now we will describe the simple case where each option is present at most once. +
    + Available Cluster Options + + Cluster Options + + + + Option + Default + Description + + + + + batch-limit + 30 + The number of jobs that the TE is allowed to execute in parallel. The "correct" value will depend on the speed and load of your network and cluster nodes. + + + no-quorum-policy + stop + + What to do when the cluster does not have quorum. + Allowed values: + + ignore - continue all resource management + freeze - continue resource management, but don't recover resources from nodes not in the affected partition + stop - stop all resources in the affected cluster parition + suicide - fence all nodes in the affected cluster partition + + + + + symmetric-cluster + TRUE + Can all resources run on any node by default? + + + stonith-enabled + TRUE + + Should failed nodes and nodes with resources that can't be stopped be shot? If you value your data, set up a STONITH device and enable this. + If true, or unset, the cluster will refuse to start resources unless one or more STONITH resources have been configured also. + + + + stonith-action + reboot + Action to send to STONITH device. Allowed values: reboot, poweroff. + + + cluster-delay + 60s + Round trip delay over the network (excluding action execution). The "correct" value will depend on the speed and load of your network and cluster nodes. + + + stop-orphan-resources + TRUE + Should deleted resources be stopped + + + stop-orphan-actions + TRUE + Should deleted actions be cancelled + + + start-failure-is-fatal + TRUE + When set to FALSE, the cluster will instead use the resource's failcount and value for resource-failure-stickiness + + + pe-error-series-max + 1 + The number of PE inputs resulting in ERRORs to save. Used when reporting problems. + + + pe-warn-series-max + 1 + The number of PE inputs resulting in WARNINGs to save. Used when reporting problems. + + + pe-input-series-max + 1 + The number of "normal" PE inputs to save. Used when reporting problems. + + + +
    + You can always obtain an up-to-date list of cluster options, including their default values by running the pengine metadata command. +
    +
    + Querying and Setting Cluster Options + + Cluster options can be queried and modified using the crm_attribute tool. + To get the current value of cluster-delay, simply use: + + crm_attribute --attr-name cluster-delay --get-value + which is more simply written as + crm_attribute --get-value -n cluster-delay + If a value is found, the you'll see a result such as this + + # crm_attribute --get-value -n cluster-delay + name=cluster-delay value=60s + However if no value is found, the tool will display an error: + + # crm_attribute --get-value -n clusta-deway + name=clusta-deway value=(null) + Error performing operation: The object/attribute does not exist + To use a different value, eg. 30s, simply run: + crm_attribute --attr-name cluster-delay --attr-value 30s + To go back to the cluster's default value, you can then delete the value with: + crm_attribute --attr-name cluster-delay --delete-attr +
    +
    + When Options are Listed More Than Once + If you ever see something like the following, it means that the option you're modifying is present more than once. + + Deleting an option that is listed twice + + # crm_attribute --attr-name batch-limit --delete-attr + Multiple attributes match name=batch-limit in crm_config: + Value: 50 (set=cib-bootstrap-options, id=cib-bootstrap-options-batch-limit) + Value: 100 (set=custom, id=custom-batch-limit) + Please choose from one of the matches above and supply the 'id' with --attr-id + + In such cases follow the on-screen instructions to perform the requested action. +To determine which value is currently being used by the cluster, please refer to the the section on . +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Resources.xml b/doc/Pacemaker_Explained/en-US/Ch-Resources.xml new file mode 100644 index 0000000000..e459a29c6b --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Resources.xml @@ -0,0 +1,505 @@ + + Cluster Resources +
    + What is a Cluster Resource + + The role of a resource agent is to abstract the service it provides and present a consistent view to the cluster, which allows the cluster to be agnostic about the resources it manages. + The cluster doesn't need to understand how the resource works because it relies on the resource agent to do the right thing when given a start, stop or monitor command. + + For this reason it is crucial that resource agents are well tested. + Typically resource agents come in the form of shell scripts, however they can be written using any technology (such as C, Python or Perl) that the author is comfortable with. +
    +
    + Supported Resource Classes + + There are three basic classes of agents supported by Pacemaker. + In order of encouraged usage they are: + +
    + Open Cluster Framework + The OCF Spec (as it relates to resource agents can be found at: ) + Note: The Pacemaker implementation has been somewhat extended from the OCF Specs, but none of those changes are incompatible with the original OCF specification and is basically an extension of the Linux Standard Base conventions for init scripts to + + support parameters + make them self describing, and + extensible + + + OCF specs have strict definitions of what exit codes actions must return + + Included with the cluster is the ocf-tester script which can be useful in this regard. + + The cluster follows these specifications exactly, and exiting with the wrong exit code will cause the cluster to behave in ways you will likely find puzzling and annoying. + In particular, the cluster needs to distinguish a completely stopped resource from one which is in some erroneous and indeterminate state. + + + Parameters are passed to the script as environment variables, with the special prefix OCF_RESKEY_. + So, if you need to be given a parameter which the user thinks of as ip it will be passed to the script as OCF_RESKEY_ip. + The number and purpose of the parameters is completely arbitrary, however your script should advertise any that it supports using the meta-data command. + + For more information, see and . +
    +
    + Linux Standard Base + + LSB resource agents are those found in /etc/init.d. + Generally they are provided by the OS/distribution and in order to be used with the cluster, must conform to the LSB Spec. + + The LSB Spec (as it relates to init scripts) can be found at: + + + Many distributions claim LSB compliance but ship with broken init scripts. + To see if your init script is LSB-compatible, see the FAQ entry . + The most common problems are: + + + Not implementing the status operation at all + Not observing the correct exit status codes for start/stop/status actions + Starting a started resource returns an error (this violates the LSB spec) + Stopping a stopped resource returns an error (this violates the LSB spec) + +
    +
    + Legacy Heartbeat + + Version 1 of Heartbeat came with its own style of resource agents and it is highly likely that many people have written their own agents based on its conventions. + To enable administrators to continue to use these agents, they are supported by the new cluster manager. + + For more information, see: + The OCF class is the most preferred one as it is an industry standard, highly flexible (allowing parameters to be passed to agents in a non-positional manner) and self-describing. + + There is also an additional class, STONITH, which is used exclusively for fencing related resources. + This is discussed later in . + +
    +
    +
    + Properties + These values tell the cluster which script to use for the resource, where to find that script and what standards it conforms to. + + Properties of a Primitive Resource + + + + Field + Description + + + + + id + Your name for the resource + + + class + The standard the script conforms to. Allowed values: heartbeat, lsb, ocf, stonith + + + type + The name of the Resource Agent you wish to use. eg. IPaddr or Filesystem + + + provider + The OCF spec allows multiple vendors to supply the same ResourceAgent. To use the OCF resource agents supplied with Heartbeat, you should specify heartbeat here. + + + +
    + Resource definitions can be queried with the crm_resource tool. For example + crm_resource --resource Email --query-xml + might produce + + An example LSB resource + + ]]> + + + One of the main drawbacks to LSB resources is that they do not allow any parameters + or, for an OCF resource: + + An example OCF resource + + + + + + +]]> + + + or, finally for the equivalent legacy Heartbeat resource: + + An example Heartbeat resource + + + + + + +]]> + + + + + Heartbeat resources take only ordered and unnamed parameters. + The supplied name therefor indicates the order in which they are passed to the script. + Only single digit values are allowed. + + +
    +
    + Resource Options + Options are used by the cluster to decide how your resource should behave and can be easily set using the --meta option of the crm_resource command. + + Options for a Primitive Resource + + + + Field + Default + Description + + + priority + 0 + If not all resources can be active, the cluster will stop lower priority resources in order to keep higher priority ones active. + + + target-role + Started + + What state should the cluster attempt to keep this resource in? Allowed values: + + Stopped - Force the resource to + Started - Allow the resource to be started (In the case of multi-state resources, they will not promoted to master) + Master - Allow the resource to be started and, if appropriate, promoted + + + + + is-managed + TRUE + + Is the cluster allowed to start and stop the resource? + Allowed values: true, false + + + + resource-stickiness + Inherited + + How much does the resource prefer to stay where it is? + Defaults to the value of resource-stickiness in the rsc_defaults section + + + + migration-threshold + 0 (disabled) + How many failures should occur for this resource on a node before making the node ineligible to host this resource. + + + failure-timeout + 0 (disabled) + How many seconds to wait before acting as if the failure had not occurred (and potentially allowing the resource back to the node on which it failed. + + + multiple-active + stop_start + + What should the cluster do if it ever finds the resource active on more than one node. Allowed values: + + block - mark the resource as unmanaged + stop_only - stop all active instances and leave them that way + stop_start - stop all active instances and start the resource in one location only + + + + + +
    + If you performed the following commands on the previous LSB Email resource + + crm_resource --meta --resource Email --set-parameter priority --property-value 100 + crm_resource --meta --resource Email --set-parameter multiple-active --property-value block + + the resulting resource definition would be + + An LSB resource with cluster options + + + + + + + +]]> + + +
    +
    + Setting Global Defaults for Resource Options + To set a default value for a resource option, simply add it to the rsc_defaults section with crm_attribute. Thus, + crm_attribute --type rsc_defaults --attr-name is-managed --attr-value false + would prevent the cluster from starting or stopping any of the resources in the configuration (unless of course the individual resources were specifically enabled and had is-managed set to true). +
    +
    + Instance Attributes + The scripts of some resource classes (LSB not being one of them) can be given parameters which determine how they behave and which instance of a service they control. + If your resource agent supports parameters, you can add them with the crm_resource command. For instance + crm_resource --resource Public-IP --set-parameter ip --property-value 1.2.3.4 + would create an entry in the resource like this + + An example OCF resource with instance attributes + + + + + + +]]> + + + For an OCF resource, the result would be an environment variable called OCF_RESKEY_ip with a value of 1.2.3.4 + + The list of instance attributes supported by an OCF script can be found by calling the resource script with the meta-data command. + The output contains an XML description of all the supported attributes, their purpose and default values. + +
    + Displaying the metadata for the Dummy resource agent template + + export OCF_ROOT=/usr/lib/ocf; $OCF_ROOT/resource.d/pacemaker/Dummy meta-data + + + + + 1.0 + + + This is a Dummy Resource Agent. It does absolutely nothing except + keep track of whether its running or not. + Its purpose in life is for testing and to serve as a template for RA writers. + + Dummy resource agent + + + + + Location to store the resource state in. + + State file + + + + + + Dummy attribute that can be changed to cause a reload + + Dummy attribute that can be changed to cause a reload + + + + + + + + + + + + + + + +]]> + + +
    +
    +
    + Resource Operations +
    + Monitoring Resources for Failure + + By default, the cluster will not ensure your resources are still healthy. + To instruct the cluster to do this, you need to add a monitor operation to the resource's definition. + + + An OCF resource with a recurring health check + + + + + + + + + +]]> + + + + Properties of an Operation + + + + Field + Description + + + id + Your name for the action. Must be unique. + + + name + The action to perform. Common values: monitor, start, stop + + + interval + How frequently (in seconds) to perform the operation. Default value: 0 + + + timeout + How long to wait before declaring the action has failed. + + + requires + + What conditions need to be satisfied before this action occurs. Allowed values: + + nothing - The cluster may start this resource at any time + quorum - The cluster can only start this resource if a majority of the configured nodes are active + fencing - The cluster can only start this resource if a majority of the configured nodes are active and any failed or unknown nodes have been powered off. + + STONITH resources default to nothing, and all others default to fencing if STONITH is enabled and quorum otherwise. + + + + on-fail + + The action to take if this action ever fails. Allowed values: + + ignore - Pretend the resource did not fail + block - Don't perform any further operations on the resource + stop - Stop the resource and do not start it elsewhere + restart - Stop the resource and start it again (possibly on a different node) + fence - STONITH the node on which the resource failed + standby - Move all resources away from the node on which the resource failed + + The default for the stop operation is fence when STONITH is enabled and block otherwise. All other operations default to stop. + + + + enabled + If false, the operation is treated as if it does not exist. Allowed values: true, false + + + +
    +
    +
    +
    + Setting Global Defaults for Operations + To set a default value for a operation option, simply add it to the op_defaults section with crm_attribute. Thus, + crm_attribute --type op_defaults --attr-name timeout --attr-value 20s + + would default each operation's timeout to 20 seconds. + If an operation's definition also includes a value for timeout, then that value would be used instead (for that operation only). + +
    + When Resources Take a Long Time to Start/Stop + + There are a number of implicit operations that the cluster will always perform - start, stop and a non-recurring monitor operation (used at startup to check the resource isn't already active). + If one of these is taking too long, then you can create an entry for them and simply specify a new value. + + + An OCF resource with custom timeouts for its implicit actions + + + + + + + + + + + +]]> + + +
    +
    + Multiple Monitor Operations + + Provided no two operations (for a single resource) have the same name and interval you can have as many monitor operations as you like. + In this way you can do a superficial health check every minute and progressively more intense ones at higher intervals. + + + To tell the resource agent what kind of check to perform, you need to provide each monitor with a different value for a common parameter. + The OCF standard creates a special parameter called OCF_CHECK_LEVEL for this purpose and dictates that it is made available to the resource agent without the normal OCF_RESKEY_ prefix. + + + Whatever name you choose, you can specify it by adding an instance_attributes block to the op tag. + Note that it is up to each resource agent to look for the parameter and decide how to use it. + + + An OCF resource with two recurring health checks performing different levels of checks + + + + + + + + + + + + + + + + + + +]]> + + +
    +
    + Disabling a Monitor Operation + + The easiest way to stop a recurring monitor is to just delete it. + However there can be times when you only want to disable it temporarily. + In such cases, simply add disabled="true" to the operation's definition. + + + Example of an OCF resource with a disabled health check + + + + + + + + + +]]> + + + This can be achieved from the command-line by executing + cibadmin -M -X ‘<op id="public-ip-check" disabled="true"/>' + Once you've done whatever you needed to do, you can then re-enable it with + cibadmin -M -X ‘<op id="public-ip-check" disabled="false"/>' +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Rules.xml b/doc/Pacemaker_Explained/en-US/Ch-Rules.xml new file mode 100644 index 0000000000..23478ec66f --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Rules.xml @@ -0,0 +1,453 @@ + + Rules + + Rules can be used to make your configuration more dynamic. + One common example is to set one value for resource-stickiness during working hours, to prevent resources from being moved back to their most preferred location, and another on weekends when no-one is around to notice an outage. + + Another use of rules might be to assign machines to different processing groups (using a node attribute) based on time and to then use that attribute when creating location constraints. + + Each rule can contain a number of expressions, date-expressions and even other rules. + The results of the expressions are combined based on the rule's boolean-op field to determine if the rule ultimately evaluates to true or false. + What happens next depends on the context in which the rule is being used. + + + Properties of a Rule + + + + Field + Description + + + + + role + Limits the rule to only apply when the resource is in that role. Allowed values: Started, Slave, Master. NOTE: A rule with role="Master" can not determine the initial location of a clone instance. It will only affect which of the active instances will be promoted. + + + score + The score to apply if the rule evaluates to "true". Limited to use in rules that are part of location constraints. + + + score-attribute + The node attribute to look up and use as a score if the rule evaluates to "true". Limited to use in rules that are part of location constraints. + + + boolean-op + How to combine the result of multiple expression objects. Allowed values: and, or + + + +
    +
    + Node Attribute Expressions + Expression objects are used to control a resource based on the attributes defined by a node or nodes. +In addition to any attributes added by the administrator, each node has a built-in node attribute called #uname that can also be used. + + Properties of an Expression + + + + Field + Description + + + value + User supplied value for comparison + + + attribute + The node attribute to test + + + type + Determines how the value(s) should be tested. Allowed values: integer, string, version + + + operation + + The comparison to perform. Allowed values: + + lt,- True if the node attribute's value is less than value + gt - True if the node attribute's value is greater than value + lte- True if the node attribute's value is less than or equal to value + gte- True if the node attribute's value is greater than or equal to value + eq- True if the node attribute's value is equal to value + ne - True if the node attribute's value is not equal to value + defined- True if the node has an the named attribute + not_defined- True if the node does not have the named attribute + + + + + +
    +
    +
    + Time/Date Based Expressions + + As the name suggests, date_expressions are used to control a resource or cluster option based on the current date/time. + They can contain an optional date_spec and/or duration object depending on the context. + + + Properties of a Date Expression + + + + Field + Description + + + start + A date/time conforming to the ISO8601 specification. + + + end + A date/time conforming to the ISO8601 specification. Can be inferred by supplying a value for start and a duration. + + + operation + + Compares the current date/time with the start and/or end date, depending on the context. Allowed values: + + gt - True if the current date/time is after start + lt - True if the current date/time is before end + in-range - True if the current date/time is after start and before end + date-spec - performs a cron-like comparison between the contents of date_spec and now + + + + + +
    + Because the comparisons (except for date_spec) include the time, the eq, neq, gte and lte operators have not been implemented. +
    + Date Specifications + + date_spec objects are used to create cron-like expressions relating to time. + Each field can contain a single number or a single range. + Instead of defaulting to zero, any field not supplied is ignored. + + + For example, monthdays="1" matches the first day of every month and hours="09-17" matches the hours between 9am and 5pm inclusive). + However at this time one cannot specify weekdays="1,2" or weekdays="1-2,5-6" since they contain multiple ranges. + Depending on demand, this may be implemented in a future release. + + + Properties of a Date Spec + + + + Field + Description + + + + + id + A unique name for the date + + + hours + Allowed values: 0-23 + + + monthdays + Allowed values: 0-31 (depending on current month and year) + + + weekdays + Allowed values: 1-7 (1=Monday, 7=Sunday) + + + yeardays + Allowed values: 1-366 (depending on the current year) + + + months + Allowed values: 1-12 + + + weeks + Allowed values: 1-53 (depending on weekyear) + + + years + Year according the Gregorian calendar + + + weekyears + + May differ from Gregorian years. + Eg. "2005-001 Ordinal" is also "2005-01-01 Gregorian" is also "2004-W53-6 Weekly" + + + + moon + Allowed values: 0..7 (0 is new, 4 is full moon). Seriously, you can use this. This was implemented to demonstrate the ease with which new comparisons could be added. + + + +
    +
    +
    + Durations + + Durations are used to calculate a value for end when one is not supplied to in_range operations. + They contain the same fields as date_spec objects but without the limitations (ie. you can have a duration of 19 days). + Like date_specs, any field not supplied is ignored. + +
    + Sample Time Based Expressions + + True if now is any time in the year 2005 + + + + + + +]]> + + + + Equivalent expression. + + + + + + +]]> + + + + 9am-5pm, Mon-Friday + + + + + + +]]> + + + + 9am-6pm, Mon-Friday, or all day saturday + + + + + + + + + +]]> + + + + 9am-5pm or 9pm-12pm, Mon-Friday + + + + + + + + + + + + + + +]]> + + + + Mondays in March 2005 + + + + + + + +]]> + + + NOTE: Because no time is specified, 00:00:00 is implied. + This means that the range includes all of 2005-03-01 but none of 2005-04-01. + You may wish to write end="2005-03-31T23:59:59" to avoid confusion. + + A full moon on Friday the 13th + + + + + + +]]> + + +
    +
    +
    +
    + Using Rules to Determine Resource Location + + If the constraint's outer-most rule evaluates to false, the cluster treats the constraint as if it was not there. + When the rule evaluates to true, the node's preference for running the resource is updated with the score associated with the rule. + + + If this sounds familiar, its because you have been using a simplified syntax for location constraint rules already. + Consider the following location constraint: + + + Prevent myApacheRsc from running on c001n03 + + <rsc_location id="dont-run-apache-on-c001n03" rsc="myApacheRsc" score="-INFINITY" node="c001n03"/> + + + This constraint can be more verbosely written as: + + Prevent myApacheRsc from running on c001n03 - expanded version + + + + + + +]]> + + + The advantage of using the expanded form is that one can then add extra clauses to the rule, such as limiting the rule such that it only applies during certain times of the day or days of the week (this is discussed in subsequent sections). + + It also allows us to match on node properties other than its name. + If we rated each machine's CPU power such that the cluster had the following nodes section: + + + A sample nodes section for use with score-attribute + + + + + + + + + + + + + +]]> + + + then we could prevent resources from running on underpowered machines with the rule + + + + +]]> + +
    + Using <literal>score-attribute</literal> Instead of <literal>score</literal> + + When using score-attribute instead of score, each node matched by the rule has its score adjusted differently, according to its value for the named node attribute. + Thus in the previous example, if a rule used score-attribute="cpu_mips", c001n01 would have its preference to run the resource increased by 1234 whereas c001n02 would have its preference increased by 5678. + +
    +
    +
    + Using Rules to Control Resource Options + Often some cluster nodes will be different from their peers, sometimes these differences (the location of a binary or the names of network interfaces) require resources be configured differently depending on the machine they're hosted on. + By defining multiple instance_attributes objects for the resource and adding a rule to each, we can easily handle these special cases. + In the example below, mySpecialRsc will use eth1 and port 9999 when run on node1, eth2 and port 8888 on node2 and default to eth0 and port 9999 for all other nodes. + + Defining different resource options based on the node name + + + + + + + + + + + + + + + + + + + + +]]> + + + + The order in which instance_attributes objects are evaluated is determined by their score (highest to lowest). + If not supplied, score defaults to zero and objects with an equal score are processed in listed order. + If the instance_attributes object does not have a rule or has a rule that evaluates to true, then for any parameter the resource does not yet have a value for, the resource will use the parameter values defined by the instance_attributes object. + +
    +
    + Using Rules to Control Cluster Options + Controlling cluster options is achieved in much the same manner as specifying different resource options on different nodes. + + The difference is that because they are cluster options, one cannot (or should not because they wont work) use attribute based expressions. + The following example illustrates how to set a different resource-stickiness value during and outside of work hours. + This allows resources to automatically move back to their most preferred hosts, but at a time that (in theory) does not interfere with business activities. + + + Set resource-stickiness=INFINITY Mon-Fri between 9am and 6pm, and resource-stickiness=0 all other times + + + + + + + + + + + + + + +]]> + + +
    +
    + Ensuring Time Based Rules Take Effect + + A Pacemaker cluster is an event driven system. + As such, it wont recalculate the best place for resources to run in unless something (like a resource failure or configuration change) happens. + This can mean that a location constraint that only allows resource X to run between 9am and 5pm is not enforced. + + + If you rely on time based rules, it is essential that you set the cluster-recheck-interval option. + This tells the cluster to periodically recalculate the ideal state of the cluster. + For example, if you set cluster-recheck-interval=5m, then sometime between 9:00 and 9:05 the cluster would notice that it needs to start resource X, and between 17:00 and 17:05 it would realize it needed to be stopped. + + Note that the timing of the actual start and stop actions depends on what else needs to be performed first. +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Status.xml b/doc/Pacemaker_Explained/en-US/Ch-Status.xml new file mode 100644 index 0000000000..139e2808d6 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Status.xml @@ -0,0 +1,273 @@ + + Status - Here be dragons + + Most users never need understand the contents of the status section and can be content with the output from crm_mon. + However for those with a curious inclination, the following attempts to proved an overview of its contents. + +
    + Node Status + In addition to the cluster's configuration, the CIB holds an up-to-date representation of each cluster node in the status section. +
    + A bare-bones status entry for a healthy node called cl-virt-1 + + + + + +]]> + +
    + + Users are highly recommended not to modify any part of a node's state directly. + The cluster will periodically regenerate the entire section from authoritative sources. + So any changes should be with the tools for those subsystems. + + + Authoritative Sources for State Information + + + + Dataset + Authoritative Source + + + node_state fields + crmd + + + transient_attributes tag + attrd + + + lrm tag + lrmd + +
    + + The fields used in the node_state objects are named as they are largely for historical reasons and are rooted in Pacemaker's origins as the Heartbeat resource manager. + They have remained unchanged to preserve compatibility with older versions. + + + Node Status Fields + + + + Field + Description + + + id + Unique identifier for the node. OpenAIS based clusters use the same value as uname, Heartbeat cluster use a human-readable (but annoying) UUID. + + + uname + The node's machine name (output from uname -n) + + + ha + Is the cluster software active on the node. Allowed values: active, dead + + + in_ccm + Is the node part of the cluster's membership. Allowed values: true, false + + + crmd + Is the crmd process active on the node. Allowed values: online, offline + + + join + Is the node participating in hosting resources. Allowed values: down, pending, member, banned + + + expected + Expected value for join + + + crm-debug-origin + Diagnostic indicator. The origin of the most recent change(s). + +
    + The cluster uses these fields to determine if, at the node level, the node is healthy or is in a failed state and needs to be fenced. +
    +
    + Transient Node Attributes + + Like regular node attributes, the name/value pairs listed here also help describe the node. + However they are forgotten by the cluster when the node goes offline. + This can be useful, for instance, when you only want a node to be in standby mode (not able to run resources) until the next reboot. + + In addition to any values the administrator sets, the cluster will also store information about failed resources here. +
    + Example set of transient node attributes for node "cl-virt-1" + + + + + + + + + +]]> + +
    + In the above example, we can see that the pingd:0 resource has failed once, at Mon Apr 6 11:22:22 2009. + + You can use the following Perl one-liner to print a human readable of any seconds-since-epoch value: + perl -e 'print scalar(localtime($seconds))."\n"' + + We also see that the node is connected to three "pingd" peers and that all known resources have been checked for on this machine (probe_complete). + +
    +
    + Operation History + + A node's resource history is held in the lrm_resources tag (a child of the lrm tag). + The information stored here includes enough information for the cluster to stop the resource safely if it is removed from the configuration section. + Specifically we store the resource's id, class, type and provider. + +
    + A record of the apcstonith resource + + <lrm_resource id="apcstonith" type="apcmastersnmp" class="stonith"> + +
    + + Additionally, we store the last job for every combination of resource, action and interval. + The concatenation of the values in this tuple are used to create the id of the lrm_rsc_op object. + + + Contents of an lrm_rsc_op job. + + + + Field + Description + + + id + Identifier for the job constructed from the resource id, operation and interval. + + + call-id + The job's ticket number. Used as a sort key to determine the order in which the jobs were executed. + + + operation + The action the resource agent was invoked with. + + + interval + The frequency, in milliseconds, at which the operation will be repeated. 0 indicates a one-off job. + + + op-status + The job's status. Generally this will be either 0 (done) or -1 (pending). Rarely used in favor of rc-code. + + + rc-code + The job's result. Refer to for details on what the values here mean and how they are interpreted. + + + last-run + Diagnostic indicator. Machine local date/time, in seconds since epoch, at which the job was executed. + + + last-rc-change + Diagnostic indicator. Machine local date/time, in seconds since epoch, at which the job first returned the current value of rc-code + + + exec-time + Diagnostic indicator. Time, in seconds, that the job was running for + + + queue-time + Diagnostic indicator. Time, in seconds, that the job was queued for in the LRMd + + + crm_feature_set + The version which this job description conforms to. Used when processing op-digest + + + transition-key + A concatenation of the job's graph action number, the graph number, the expected result and the UUID of the crmd instance that scheduled it. This is used to construct transition-magic (below). + + + transition-magic + A concatenation of the job's op-status, rc-code and transition-key. Guaranteed to be unique for the life of the cluster (which ensures it is part of CIB update notifications) and contains all the information needed for the crmd to correctly analyze and process the completed job. Most importantly, the decomposed elements tell the crmd if the job entry was expected and whether it failed. + + + op-digest + An MD5 sum representing the parameters passed to the job. Used to detect changes to the configuration and restart resources if necessary. + + + crm-debug-origin + Diagnostic indicator. The origin of the current values. + + + +
    +
    + Simple Example +
    + A monitor operation performed by the cluster to determine the current state of the apcstonith resource + + + + +]]> + +
    + + In the above example, the job is a non-recurring monitor often referred to as a "probe" for the apcstonith resource. + The cluster schedules probes for every configured resource on when a new node starts, in order to determine the resource's current state before it takes further any further action. + + + From the transition-key, we can see that this was the 22nd action of the 2nd graph produced by this instance of the crmd (2668bbeb-06d5-40f9-936d-24cb7f87006a). + The third field of the transition-key contains a 7, this indicates that the job expects to find the resource inactive. + By now looking at the rc-code property, we see that this was the case. + + Evidently, the cluster started the resource elsewhere as that is the only job recorded for this node. +
    +
    + Complex Resource History Example +
    + Resource history of a pingd clone with multiple jobs + + + + + + + +]]> + +
    + + When more than one job record exists, it is important to first sort them by call-id before interpret them. + Once sorted, the above example can be summarized as: + + + A non-recurring monitor operation returning 7 (not running), with a call-id of 3 + A stop operation returning 0 (success), with a call-id of 32 + A start operation returning 0 (success), with a call-id of 33 + A recurring monitor returning 0 (success), with a call-id of 34 + + + The cluster processes each job record to build up a picture of the resource's state. + After the first and second entries, it is considered stopped and after the third it considered active. + Based on the last operation, we can tell that the resource is currently active. + + + Additionally, from the presence of a stop operation with a lower call-id than that of the start operation, we can conclude that the resource has been restarted. + Specifically this occurred as part of actions 11 and 31 of transition 11 from the crmd instance with the key 2668bbeb-06d5-40f9-936d-24cb7f87006a. + This information can be helpful for locating the relevant section of the logs when looking for the source of a failure. + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Ch-Stonith.xml b/doc/Pacemaker_Explained/en-US/Ch-Stonith.xml new file mode 100644 index 0000000000..23ea52f015 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Ch-Stonith.xml @@ -0,0 +1,84 @@ + + Protecting Your Data - STONITH +
    + Why You Need STONITH + STONITH is an acronym for Shoot-The-Other-Node-In-The-Head and it protects your data from being corrupted by rouge nodes or concurrent access. + + Just because a node is unresponsive, this doesn't mean it isn't accessing your data. + The only way to be 100% sure that your data is safe, is to use STONITH so we can be certain that the node is truly offline, before allowing the data to be accessed from another node. + + + STONITH also has a role to play in the event that a clustered service cannot be stopped. + In this case, the cluster uses STONITH to force the whole node offline, thereby making it safe to start the service elsewhere. + +
    +
    + What STONITH Device Should You Use + It is crucial that the STONITH device can allow the cluster to differentiate between a node failure and a network one. + + The biggest mistake people make in choosing a STONITH device is to use remote power switch (such as many on-board IMPI controllers) that shares power with the node it controls. + In such cases, the cluster cannot be sure if the node is really offline, or active and suffering from a network fault. + + Likewise, any device that relies on the machine being active (such as SSH-based "devices" used during testing) are inappropriate. +
    +
    + Configuring STONITH + + + Find the correct driver: stonith -L + + + + Since every device is different, the parameters needed to configure it will vary. + To find out the parameters required by the device: stonith -t {type} -n + + Hopefully the developers chose names that make sense, if not you can query for some additional information by finding an active cluster node and running: + lrmadmin -M stonith {type} pacemaker + The output should be XML formatted text containing additional parameter descriptions + + Create a file called stonith.xml containing a primitive resource with a class of stonith, a type of {type} and a parameter for each of the values returned in step 2 + Create a clone from the primitive resource if the device can shoot more than one node and supports multiple simultaneous connections. + Upload it into the CIB using cibadmin: cibadmin -C -o resources --xml-file stonith.xml + +
    + Example + Assuming we have an IBM BladeCenter consisting of four nodes and the management interface is active on 10.0.0.1, then we would chose the external/ibmrsa driver in step 2 and obtain the following list of parameters +
    + Obtaining a list of STONITH Parameters + + + stonith -t external/ibmrsa -n + + + hostname ipaddr userid passwd type + + +
    + from which we would create a STONITH resource fragment that might look like this + + Sample STONITH Resource + + + + + + + + + + + + + + + + + + +]]> + + +
    +
    +     diff --git a/doc/Pacemaker_Explained/en-US/Pacemaker_Explained.ent b/doc/Pacemaker_Explained/en-US/Pacemaker_Explained.ent new file mode 100644 index 0000000000..aa12346dcd --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Pacemaker_Explained.ent @@ -0,0 +1,4 @@ + + + + diff --git a/doc/Pacemaker_Explained/en-US/Pacemaker_Explained.xml b/doc/Pacemaker_Explained/en-US/Pacemaker_Explained.xml new file mode 100644 index 0000000000..d019bdcc71 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Pacemaker_Explained.xml @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + Receiving Notification of Cluster Events +
    Configuring Email Notifications
    +
    Configuring SNMP Notifications
    +     + + + + + + + + + + + + + + + + Further Reading + + Project Website: and Documentation + + Cluster Commands + A comprehensive guide to cluster commands has been written by Novell and can be found at: + + Heartbeat configuration: + OpenAIS Configuration: + + + + + +     diff --git a/doc/Pacemaker_Explained/en-US/Preface.xml b/doc/Pacemaker_Explained/en-US/Preface.xml new file mode 100644 index 0000000000..eadd41d900 --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Preface.xml @@ -0,0 +1,11 @@ + + +Preface + + + + + + + diff --git a/doc/Pacemaker_Explained/en-US/Revision_History.xml b/doc/Pacemaker_Explained/en-US/Revision_History.xml new file mode 100644 index 0000000000..5dc95ecd1e --- /dev/null +++ b/doc/Pacemaker_Explained/en-US/Revision_History.xml @@ -0,0 +1,33 @@ + + + + Revision History + + + + 1 + 19 Oct 2009 + AndrewBeekhofandrew@beekhof.net + Import from Pages.app + + + 2 + 26 Oct 2009 + AndrewBeekhofandrew@beekhof.net + Cleanup and reformatting of docbook xml complete + + + 3 + Tue Nov 12 2009 + AndrewBeekhofandrew@beekhof.net + + + Split book into chapters and pass validation + Re-organize book for use with Publican + + + + + + diff --git a/doc/Pacemaker_Explained/publican.cfg b/doc/Pacemaker_Explained/publican.cfg new file mode 100644 index 0000000000..7ca9eaeb26 --- /dev/null +++ b/doc/Pacemaker_Explained/publican.cfg @@ -0,0 +1,14 @@ +# Config::Simple 4.59 +# Tue Nov 10 22:28:47 2009 + +docname: Pacemaker_Explained +version: 1.0 +xml_lang: en-US +#edition: 1 +type: Book +brand: clusterlabs +product: Pacemaker + +chunk_first: 0 +chunk_section_depth: 3 +generate_section_toc_level: 4